Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion conda-env/environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ dependencies:
# ==================
# Base
# ==================
- python>=3.7
- python>=3.10
- numpy
- bokeh
- matplotlib
Expand Down
75 changes: 62 additions & 13 deletions docs/examples/example_scatter_plot.ipynb

Large diffs are not rendered by default.

Binary file added docs/examples/images/model_sample1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/examples/images/model_sample2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/examples/images/model_sample3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ BSD 3-Clause License.
:caption: For users:

overview
installation
gallery

.. toctree::
Expand Down
63 changes: 63 additions & 0 deletions docs/installation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
.. _installation:

Installation
============

The **ESMBenchmarkViz** package is not yet available on the conda-forge channel. To install it, 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 <https://github.com/git-guides/install-git>`_ and `pip <https://pip.pypa.io/en/stable/installation/>`_ installed on your system
- `numpy <https://numpy.org/>`_, `bokeh <https://docs.bokeh.org/en/latest/>`_, `matplotlib <https://matplotlib.org/>`_ libraries installed (These will be installed automatically if you follow the conda environment setup in Step 2)
- (Optional, but recommended) `conda <https://docs.conda.io/en/latest/>`_ for environment management

Step 1: Clone the Repository
----------------------------

Clone the repository from `GitHub <https://github.com/PCMDI/ESMBenchmarkViz.git>`_ to your local machine:

.. code-block:: bash

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 <https://docs.conda.io/en/latest/>`_ environment to manage dependencies. You can create and activate a new environment as follows:

.. code-block:: bash

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:

.. code-block:: bash

pip install .

Verifying the Installation
--------------------------

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

.. code-block:: bash

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 <https://github.com/PCMDI/ESMBenchmarkViz/blob/main/README.md>`_ in the repository or open an issue on the `ESMBenchmarkViz GitHub page <https://github.com/PCMDI/ESMBenchmarkViz/issues>`_.

----

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