Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Miniconda references to Miniforge in HPC docs #731

Merged
merged 1 commit into from
Jan 31, 2025
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
5 changes: 2 additions & 3 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ Creating a development environment
Before starting any development, you'll need to create an isolated xCDAT
development environment:

- We recommend installing `Anaconda`_ or `Miniconda`_
- We recommend installing `Anaconda`_ or `Miniforge3`_
- Make sure your conda is up to date (``conda update conda``)
- Make sure that you have forked and cloned the `repository`_. If you are in the xCDAT
organization, forking is not needed since you will have direct read access to the repository
Expand Down Expand Up @@ -192,9 +192,8 @@ To return to your root environment:

See the full `conda docs here`_.

.. _Miniforge: https://github.com/conda-forge/miniforge
.. _Anaconda: https://www.anaconda.com/download
.. _Miniconda: https://docs.conda.io/projects/miniconda/en/latest/
.. _Miniforge3: https://github.com/conda-forge/miniforge
.. _repository: https://github.com/xCDAT/xcdat
.. _conda docs here: http://conda.pydata.org/docs

Expand Down
7 changes: 6 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ help:

# Clean local repository
# ----------------------
clean: clean-build clean-pyc clean-test ## remove all build, test, coverage and Python artifacts
clean: clean-build clean-docs clean-pyc clean-test ## remove all build, docs, test, coverage and Python artifacts

clean-build: ## remove build artifacts
rm -fr build/
Expand All @@ -55,6 +55,10 @@ clean-test: ## remove test and coverage artifacts
rm -fr .pytest_cache
rm -rf .mypy_cache

clean-docs:
rm -rf docs/_build
rm -rf docs/generated

# Quality Assurance
# ----------------------
pre-commit: # run pre-commit quality assurance checks
Expand All @@ -74,6 +78,7 @@ test: ## run tests quickly with the default Python and produces code coverage re
# Documentation
# ----------------------
docs: ## generate Sphinx HTML documentation, including API docs
rm -rf docs/_build
rm -rf docs/generated
cd docs && make html
$(MAKE) -C docs clean
Expand Down
1 change: 0 additions & 1 deletion conda-env/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,3 @@ dependencies:
# ==================
- pytest
- pytest-cov
prefix: /opt/miniconda3/envs/xcdat_ci
1 change: 0 additions & 1 deletion conda-env/dev.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,3 @@ dependencies:
# ==================
- jupyterlab
- tbump
prefix: /opt/miniconda3/envs/xcdat_dev
4 changes: 2 additions & 2 deletions docs/getting-started-guide/getting-started-hpc-jupyter.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@ Ensure ``conda`` is installed
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

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

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