Skip to content

Commit 7d99c85

Browse files
Update Miniconda references to Miniforge in HPC docs (#731)
- Add `clean-docs` command to `Makefile` - Delete unused `prefix` from conda env yml files
1 parent 84e4a3f commit 7d99c85

File tree

5 files changed

+10
-8
lines changed

5 files changed

+10
-8
lines changed

CONTRIBUTING.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ Creating a development environment
150150
Before starting any development, you'll need to create an isolated xCDAT
151151
development environment:
152152

153-
- We recommend installing `Anaconda`_ or `Miniconda`_
153+
- We recommend installing `Anaconda`_ or `Miniforge3`_
154154
- Make sure your conda is up to date (``conda update conda``)
155155
- Make sure that you have forked and cloned the `repository`_. If you are in the xCDAT
156156
organization, forking is not needed since you will have direct read access to the repository
@@ -192,9 +192,8 @@ To return to your root environment:
192192
193193
See the full `conda docs here`_.
194194

195-
.. _Miniforge: https://github.com/conda-forge/miniforge
196195
.. _Anaconda: https://www.anaconda.com/download
197-
.. _Miniconda: https://docs.conda.io/projects/miniconda/en/latest/
196+
.. _Miniforge3: https://github.com/conda-forge/miniforge
198197
.. _repository: https://github.com/xCDAT/xcdat
199198
.. _conda docs here: http://conda.pydata.org/docs
200199

Makefile

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ help:
3131

3232
# Clean local repository
3333
# ----------------------
34-
clean: clean-build clean-pyc clean-test ## remove all build, test, coverage and Python artifacts
34+
clean: clean-build clean-docs clean-pyc clean-test ## remove all build, docs, test, coverage and Python artifacts
3535

3636
clean-build: ## remove build artifacts
3737
rm -fr build/
@@ -55,6 +55,10 @@ clean-test: ## remove test and coverage artifacts
5555
rm -fr .pytest_cache
5656
rm -rf .mypy_cache
5757

58+
clean-docs:
59+
rm -rf docs/_build
60+
rm -rf docs/generated
61+
5862
# Quality Assurance
5963
# ----------------------
6064
pre-commit: # run pre-commit quality assurance checks
@@ -74,6 +78,7 @@ test: ## run tests quickly with the default Python and produces code coverage re
7478
# Documentation
7579
# ----------------------
7680
docs: ## generate Sphinx HTML documentation, including API docs
81+
rm -rf docs/_build
7782
rm -rf docs/generated
7883
cd docs && make html
7984
$(MAKE) -C docs clean

conda-env/ci.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,3 @@ dependencies:
2424
# ==================
2525
- pytest
2626
- pytest-cov
27-
prefix: /opt/miniconda3/envs/xcdat_ci

conda-env/dev.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,4 +47,3 @@ dependencies:
4747
# ==================
4848
- jupyterlab
4949
- tbump
50-
prefix: /opt/miniconda3/envs/xcdat_dev

docs/getting-started-guide/getting-started-hpc-jupyter.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ Ensure ``conda`` is installed
2020
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2121

2222
Generally, the installation instructions from the `Installation <../installation.rst>`_
23-
page can also be followed for HPC machines. This guide covers installing Miniconda3 and
23+
page can also be followed for HPC machines. This guide covers installing Miniforge3 and
2424
creating a conda environment with the ``xcdat`` package.
2525

26-
Before installing Miniconda3, you should consult your HPC documentation to see if
26+
Before installing Miniforge3, you should consult your HPC documentation to see if
2727
``conda`` is already available; in some cases, ``python`` and ``conda`` may be
2828
pre-installed on an HPC machine. You can check to see whether they are available by
2929
entering ``which conda`` and/or ``which python`` in the command line (which will

0 commit comments

Comments
 (0)