Skip to content

Commit 86dab19

Browse files
committed
Updated docs and README with conda and mamba installation instructions.
1 parent b7f645b commit 86dab19

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-6
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ You may contact me, Dion, through dh3065@columbia.edu.
1919

2020
The **GitHub repository** is https://github.com/LDEO-CREW/Pythonic-DISORT.
2121

22-
Accompanying Journal of Open Source Software paper: https://joss.theoj.org/papers/10.21105/joss.06442.
22+
Accompanying Journal of Open Source Software paper: https://joss.theoj.org/papers/10.21105/joss.06442. **Please cite this paper if you use PythonicDISORT**.
2323

2424
# Documentation
2525
https://pythonic-disort.readthedocs.io/en/latest/
@@ -54,7 +54,7 @@ These notebooks double up as examples of how to use PythonicDISORT. The tests wh
5454
# Installation
5555

5656
* From PyPI: `pip install PythonicDISORT`
57-
* From Conda-forge: (TODO: need to first publish on Conda-forge)
57+
* From Conda-Forge: `conda install -c conda-forge pythonicdisort` or `mamba install -c conda-forge pythonicdisort`
5858
* By cloning repository: `pip install .` in the `Pythonic-DISORT` directory; `pip install -r all_optional_dependencies.txt` to install all optional dependencies (see *Requirements to run PythonicDISORT*)
5959

6060
## Requirements to run PythonicDISORT

docs/Pythonic-DISORT.ipynb

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,11 +46,13 @@
4646
"id": "fd874e5a",
4747
"metadata": {},
4848
"source": [
49-
"**Installation and more examples of use**\n",
49+
"**Installation options and more examples of use**\n",
5050
"\n",
51-
"`pip install PythonicDISORT`\n",
51+
"* `pip install PythonicDISORT`\n",
52+
"* `conda install -c conda-forge pythonicdisort`\n",
53+
"* `mamba install -c conda-forge pythonicdisort`\n",
5254
"\n",
53-
"See https://github.com/LDEO-CREW/Pythonic-DISORT for other installation options. See the Jupyter Notebooks in the `pydisotest` directory for more examples of use."
55+
"See https://github.com/LDEO-CREW/Pythonic-DISORT for further installation details. See the Jupyter Notebooks in the `pydisotest` directory for more examples of use."
5456
]
5557
},
5658
{
@@ -6060,7 +6062,7 @@
60606062
"name": "python",
60616063
"nbconvert_exporter": "python",
60626064
"pygments_lexer": "ipython3",
6063-
"version": "3.13.2"
6065+
"version": "3.11.8"
60646066
}
60656067
},
60666068
"nbformat": 4,

0 commit comments

Comments
 (0)