Skip to content

Commit 2710844

Browse files
authored
Enhance installation guide for esmbenchmarkviz
Added detailed installation instructions for esmbenchmarkviz using conda and mamba, including version search and dependency queries.
1 parent f5b0c2d commit 2710844

File tree

1 file changed

+50
-3
lines changed

1 file changed

+50
-3
lines changed

docs/installation.rst

Lines changed: 50 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,54 @@
11
.. _installation:
22

3-
Installation
4-
============
3+
Installation using conda (recommended)
4+
======================================
5+
6+
Installing `esmbenchmarkviz` from the `conda-forge` channel can be achieved by adding `conda-forge` to your channels with:
7+
8+
```
9+
conda config --add channels conda-forge
10+
conda config --set channel_priority strict
11+
```
12+
13+
Once the `conda-forge` channel has been enabled, `esmbenchmarkviz` can be installed with `conda`:
14+
15+
```
16+
conda install esmbenchmarkviz
17+
```
18+
19+
or with `mamba`:
20+
21+
```
22+
mamba install esmbenchmarkviz
23+
```
24+
25+
It is possible to list all of the versions of `esmbenchmarkviz` available on your platform with `conda`:
26+
27+
```
28+
conda search esmbenchmarkviz --channel conda-forge
29+
```
30+
31+
or with `mamba`:
32+
33+
```
34+
mamba search esmbenchmarkviz --channel conda-forge
35+
```
36+
37+
Alternatively, `mamba repoquery` may provide more information:
38+
39+
```
40+
# Search all versions available on your platform:
41+
mamba repoquery search esmbenchmarkviz --channel conda-forge
42+
43+
# List packages depending on `esmbenchmarkviz`:
44+
mamba repoquery whoneeds esmbenchmarkviz --channel conda-forge
45+
46+
# List dependencies of `esmbenchmarkviz`:
47+
mamba repoquery depends esmbenchmarkviz --channel conda-forge
48+
```
49+
50+
Installation from the source code
51+
=================================
552

653
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.
754

@@ -60,4 +107,4 @@ If you encounter any issues during installation, please check that you have the
60107

61108
----
62109

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

0 commit comments

Comments
 (0)