Merge pull request #43 from PCMDI/lee1043-patch-1

Update docs for the package and installation

Author: lee1043

README.md

@@ -12,6 +12,10 @@
 [![Formatted with black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/python/black)
 
 
+| Name | Downloads | Version | Platforms |
+| --- | --- | --- | --- |
+| [![Conda Recipe](https://img.shields.io/badge/recipe-esmbenchmarkviz-green.svg)](https://anaconda.org/conda-forge/esmbenchmarkviz) | [![Conda Downloads](https://img.shields.io/conda/dn/conda-forge/esmbenchmarkviz.svg)](https://anaconda.org/conda-forge/esmbenchmarkviz) | [![Conda Version](https://img.shields.io/conda/vn/conda-forge/esmbenchmarkviz.svg)](https://anaconda.org/conda-forge/esmbenchmarkviz) | [![Conda Platforms](https://img.shields.io/conda/pn/conda-forge/esmbenchmarkviz.svg)](https://anaconda.org/conda-forge/esmbenchmarkviz) |
+
 ESMBenchmarkViz is a Python-based interactive visualization toolkit built with Bokeh, designed to facilitate the collective evaluation, intercomparison, and benchmarking of Earth System Models (ESMs). The tool provides a user-friendly interface for analyzing model performance, enabling researchers to make informed comparisons and insights into ESM behavior.
 
 ## Developer

docs/installation.rst

@@ -1,9 +1,60 @@
 .. _installation:
 
-Installation
-============
+Installation using conda (recommended)
+======================================
 
-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.
+Installing `esmbenchmarkviz` from the `conda-forge` channel can be achieved by adding `conda-forge` to your channels with:
+
+.. code-block:: bash
+
+    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`:
+
+.. code-block:: bash
+
+    conda install esmbenchmarkviz
+
+or with `mamba`:
+
+.. code-block:: bash
+
+    mamba install esmbenchmarkviz
+
+
+It is possible to list all of the versions of `esmbenchmarkviz` available on your platform with `conda`:
+
+.. code-block:: bash
+
+    conda search esmbenchmarkviz --channel conda-forge
+
+
+or with `mamba`:
+
+.. code-block:: bash
+
+    mamba search esmbenchmarkviz --channel conda-forge
+
+
+Alternatively, `mamba repoquery` may provide more information:
+
+.. code-block:: bash
+
+    # 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
 -------------
@@ -60,4 +111,4 @@ If you encounter any issues during installation, please check that you have the
 
 ----
 
-For more information, visit the project repository: https://github.com/PCMDI/ESMBenchmarkViz
+For more information, visit the project repository: https://github.com/PCMDI/ESMBenchmarkViz