diff --git a/docs/source/quickinstall.rst b/docs/source/quickinstall.rst index e3138a53b..480db5be6 100644 --- a/docs/source/quickinstall.rst +++ b/docs/source/quickinstall.rst @@ -8,39 +8,56 @@ This quick install guide outlines the basic steps needed to install OpenMC on your computer. For more detailed instructions on configuring and installing OpenMC, see :ref:`usersguide_install` in the User's Manual. ----------------------------------------- -Installing on Linux/Mac with conda-forge ----------------------------------------- +-------------------------------------------------- +Installing on Linux/Mac with Mamba and conda-forge +-------------------------------------------------- `Conda `_ is an open source package management -system and environment management system for installing multiple versions of -software packages and their dependencies and switching easily between them. If -you have `conda` installed on your system, OpenMC can be installed via the -`conda-forge` channel. First, add the `conda-forge` channel with: +system and environments management system for installing multiple versions of +software packages and their dependencies and switching easily between them. +`Mamba `_ is a cross-platform package +manager and is compatible with `conda` packages. +OpenMC can be installed in a `conda` environment with `mamba`. +First, `conda` should be installed with one of the following installers: +`Miniconda `_, +`Anaconda `_, or `Miniforge `_. +Once you have `conda` installed on your system, OpenMC can be installed via the +`conda-forge` channel with `mamba`. + +First, add the `conda-forge` channel with: .. code-block:: sh conda config --add channels conda-forge +Then create and activate a new conda enviroment called `openmc-env` in +which to install OpenMC. + +.. code-block:: sh + + conda create -n openmc-env + conda activate openmc-env + +Then install `mamba`, which will be used to install OpenMC. + +.. code-block:: sh + + conda install mamba + To list the versions of OpenMC that are available on the `conda-forge` channel, in your terminal window or an Anaconda Prompt run: .. code-block:: sh - conda search openmc + mamba search openmc OpenMC can then be installed with: .. code-block:: sh - conda create -n openmc-env openmc + mamba install openmc -This will install OpenMC in a conda environment called `openmc-env`. To activate -the environment, run: - -.. code-block:: sh - - conda activate openmc-env +You are now in a conda environment called `openmc-env` that has OpenMC installed. ------------------------------------------- Installing on Linux/Mac/Windows with Docker diff --git a/docs/source/usersguide/install.rst b/docs/source/usersguide/install.rst index 3e3f7754a..d05c00bb3 100644 --- a/docs/source/usersguide/install.rst +++ b/docs/source/usersguide/install.rst @@ -8,39 +8,56 @@ Installation and Configuration .. _install_conda: ----------------------------------------- -Installing on Linux/Mac with conda-forge ----------------------------------------- +-------------------------------------------------- +Installing on Linux/Mac with Mamba and conda-forge +-------------------------------------------------- -Conda_ is an open source package management system and environment management -system for installing multiple versions of software packages and their -dependencies and switching easily between them. If you have `conda` installed on -your system, OpenMC can be installed via the `conda-forge` channel. First, add -the `conda-forge` channel with: +`Conda `_ is an open source package management +systems and environments management system for installing multiple versions of +software packages and their dependencies and switching easily between them. +`Mamba `_ is a cross-platform package +manager and is compatible with `conda` packages. +OpenMC can be installed in a `conda` environment with `mamba`. +First, `conda` should be installed with one of the following installers: +`Miniconda `_, +`Anaconda `_, or `Miniforge `_. +Once you have `conda` installed on your system, OpenMC can be installed via the +`conda-forge` channel with `mamba`. + +First, add the `conda-forge` channel with: .. code-block:: sh conda config --add channels conda-forge +Then create and activate a new conda enviroment called `openmc-env` in +which to install OpenMC. + +.. code-block:: sh + + conda create -n openmc-env + conda activate openmc-env + +Then install `mamba`, which will be used to install OpenMC. + +.. code-block:: sh + + conda install mamba + To list the versions of OpenMC that are available on the `conda-forge` channel, in your terminal window or an Anaconda Prompt run: .. code-block:: sh - conda search openmc + mamba search openmc OpenMC can then be installed with: .. code-block:: sh - conda create -n openmc-env openmc + mamba install openmc -This will install OpenMC in a conda environment called `openmc-env`. To activate -the environment, run: - -.. code-block:: sh - - conda activate openmc-env +You are now in a conda environment called `openmc-env` that has OpenMC installed. ------------------------------------------- Installing on Linux/Mac/Windows with Docker