Installation using conda (recommended)

Installing esmbenchmarkviz from the conda-forge channel can be achieved by adding conda-forge to your channels with:

conda config --add channels conda-forge
conda config --set channel_priority strict

Once the conda-forge channel has been enabled, esmbenchmarkviz can be installed with conda:

conda install esmbenchmarkviz

or with mamba:

mamba install esmbenchmarkviz

It is possible to list all of the versions of esmbenchmarkviz available on your platform with conda:

conda search esmbenchmarkviz --channel conda-forge

or with mamba:

mamba search esmbenchmarkviz --channel conda-forge

Alternatively, mamba repoquery may provide more information:

# Search all versions available on your platform:
mamba repoquery search esmbenchmarkviz --channel conda-forge

# List packages depending on `esmbenchmarkviz`:
mamba repoquery whoneeds esmbenchmarkviz --channel conda-forge

# List dependencies of `esmbenchmarkviz`:
mamba repoquery depends esmbenchmarkviz --channel conda-forge

Installation from the source code

To install from the source code, you will need to clone the repository and install it locally using pip. The following steps will guide you through the process.

Prerequisites

Python 3.10 or higher
git and pip installed on your system
numpy, bokeh, matplotlib libraries installed (These will be installed automatically if you follow the conda environment setup in Step 2)
(Optional, but recommended) conda for environment management

Step 1: Clone the Repository

Clone the repository from GitHub to your local machine:

git clone https://github.com/PCMDI/ESMBenchmarkViz.git
cd ESMBenchmarkViz

Step 2: (Optional) Create and Activate a Conda Environment

It is recommended to use a conda environment to manage dependencies. You can create and activate a new environment as follows:

conda create -n esmbenchmarkviz -f conda_env/environment.yml
conda activate esmbenchmarkviz

Step 3: Install the Package

Install the package using pip from the root directory of the cloned repository:

pip install .

Verifying the Installation

After installation, you can verify that the package is installed by running:

python -c "import ESMBenchmarkViz; print(ESMBenchmarkViz.__version__)"

If you see the version number printed without errors, the installation was successful.

Troubleshooting

If you encounter any issues during installation, please check that you have the required dependencies and that you are using a compatible Python version. For further assistance, refer to the README.md in the repository or open an issue on the ESMBenchmarkViz GitHub page.

For more information, visit the project repository: https://github.com/PCMDI/ESMBenchmarkViz