From fc454abcd1a98dd796623f16dc6d32b4fce7aa63 Mon Sep 17 00:00:00 2001 From: Kalin Kiesling Date: Thu, 12 May 2022 13:18:53 -0500 Subject: [PATCH 1/7] updated conda install to specify using mamba instead --- docs/source/quickinstall.rst | 26 +++++++++++++++++++------- 1 file changed, 19 insertions(+), 7 deletions(-) diff --git a/docs/source/quickinstall.rst b/docs/source/quickinstall.rst index e3138a53b..f3225191e 100644 --- a/docs/source/quickinstall.rst +++ b/docs/source/quickinstall.rst @@ -8,13 +8,15 @@ 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 +`Conda `_ and `Mamba `_ +are 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. +All conda packages can be installed with If you have `conda` installed on your system, OpenMC can be installed via the `conda-forge` channel. First, add the `conda-forge` channel with: @@ -22,6 +24,12 @@ you have `conda` installed on your system, OpenMC can be installed via the conda config --add channels conda-forge +Then install `mamba`, which will later be used to install OpenMC in the conda environment. + +.. 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: @@ -33,7 +41,7 @@ OpenMC can then be installed with: .. code-block:: sh - conda create -n openmc-env openmc + mamba create -n openmc-env openmc This will install OpenMC in a conda environment called `openmc-env`. To activate the environment, run: @@ -42,6 +50,10 @@ the environment, run: conda activate openmc-env +.. note:: If you are already familiar with conda for package management, + please note that OpenMC is currently only supported to be installed + with `mamba` and not `conda` (ie, `conda install openmc` may not work). + ------------------------------------------- Installing on Linux/Mac/Windows with Docker ------------------------------------------- From ea74bf0e4ae30819299fcaa9e6ea08fdd83d3683 Mon Sep 17 00:00:00 2001 From: Kalin Kiesling Date: Thu, 12 May 2022 13:20:40 -0500 Subject: [PATCH 2/7] typo --- docs/source/quickinstall.rst | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/source/quickinstall.rst b/docs/source/quickinstall.rst index f3225191e..cd848d395 100644 --- a/docs/source/quickinstall.rst +++ b/docs/source/quickinstall.rst @@ -15,9 +15,8 @@ Installing on Linux/Mac with Mamba and conda-forge `Conda `_ and `Mamba `_ are 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. -All conda packages can be installed with If -you have `conda` installed on your system, OpenMC can be installed via the +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: .. code-block:: sh From d8dc09e3153a860523134b566a3a1ec728948fc2 Mon Sep 17 00:00:00 2001 From: Kalin Kiesling Date: Thu, 12 May 2022 13:29:00 -0500 Subject: [PATCH 3/7] mamba create -n opemnc actually still uses conda install, so updated to make it two different steps to avoid failure --- docs/source/quickinstall.rst | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/docs/source/quickinstall.rst b/docs/source/quickinstall.rst index cd848d395..57ff2b479 100644 --- a/docs/source/quickinstall.rst +++ b/docs/source/quickinstall.rst @@ -34,20 +34,22 @@ in your terminal window or an Anaconda Prompt run: .. code-block:: sh - conda search openmc + mamba search openmc + +First 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 OpenMC can then be installed with: .. code-block:: sh - mamba 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. .. note:: If you are already familiar with conda for package management, please note that OpenMC is currently only supported to be installed From 4efb74317951f13571867d97f9171dbe3a59ebab Mon Sep 17 00:00:00 2001 From: Kalin Kiesling Date: Mon, 16 May 2022 11:29:14 -0500 Subject: [PATCH 4/7] reorder mamba install instructions --- docs/source/quickinstall.rst | 24 +++++++++++------------- 1 file changed, 11 insertions(+), 13 deletions(-) diff --git a/docs/source/quickinstall.rst b/docs/source/quickinstall.rst index 57ff2b479..db2d464b3 100644 --- a/docs/source/quickinstall.rst +++ b/docs/source/quickinstall.rst @@ -17,13 +17,22 @@ are 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. 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-forge` channel. + +First, add the `conda-forge` channel with: .. code-block:: sh conda config --add channels conda-forge -Then install `mamba`, which will later be used to install OpenMC in the conda environment. +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 @@ -36,13 +45,6 @@ in your terminal window or an Anaconda Prompt run: mamba search openmc -First 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 - OpenMC can then be installed with: .. code-block:: sh @@ -51,10 +53,6 @@ OpenMC can then be installed with: You are now in a conda environment called `openmc-env` that has OpenMC installed. -.. note:: If you are already familiar with conda for package management, - please note that OpenMC is currently only supported to be installed - with `mamba` and not `conda` (ie, `conda install openmc` may not work). - ------------------------------------------- Installing on Linux/Mac/Windows with Docker ------------------------------------------- From 3a44e1fce9bff829d759865c1f79c0e5a435f086 Mon Sep 17 00:00:00 2001 From: Kalin Kiesling Date: Mon, 16 May 2022 11:39:40 -0500 Subject: [PATCH 5/7] more details on mamba vs conda --- docs/source/quickinstall.rst | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/docs/source/quickinstall.rst b/docs/source/quickinstall.rst index db2d464b3..81a442f47 100644 --- a/docs/source/quickinstall.rst +++ b/docs/source/quickinstall.rst @@ -12,12 +12,17 @@ OpenMC, see :ref:`usersguide_install` in the User's Manual. Installing on Linux/Mac with Mamba and conda-forge -------------------------------------------------- -`Conda `_ and `Mamba `_ -are 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. If you have `conda` installed -on your system, OpenMC can be installed via the -`conda-forge` channel. +`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: @@ -25,7 +30,8 @@ First, add the `conda-forge` channel with: conda config --add channels conda-forge -Then create and activate a new conda enviroment called `openmc-env` in which to install OpenMC. +Then create and activate a new conda enviroment called `openmc-env` in +which to install OpenMC. .. code-block:: sh From 2b779091daabc71a982727fb9d482f5611588ae0 Mon Sep 17 00:00:00 2001 From: Kalin Kiesling Date: Mon, 16 May 2022 11:41:03 -0500 Subject: [PATCH 6/7] update same info in install.rst --- docs/source/usersguide/install.rst | 49 ++++++++++++++++++++---------- 1 file changed, 33 insertions(+), 16 deletions(-) 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 From 84a4eb57fbb39938b09a5d91cdcbbd7b08bc8ad8 Mon Sep 17 00:00:00 2001 From: Kalin Kiesling Date: Wed, 25 May 2022 13:35:00 -0500 Subject: [PATCH 7/7] Update docs/source/quickinstall.rst Co-authored-by: Paul Romano --- docs/source/quickinstall.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/quickinstall.rst b/docs/source/quickinstall.rst index 81a442f47..480db5be6 100644 --- a/docs/source/quickinstall.rst +++ b/docs/source/quickinstall.rst @@ -13,7 +13,7 @@ Installing on Linux/Mac with Mamba and conda-forge -------------------------------------------------- `Conda `_ is an open source package management -systems and environments management system for installing multiple versions of +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.