Merge pull request #1756 from willend/main

Installation rewording for conda-envs
McStasMcXtrace · Nov 5, 2024 · df3662a · df3662a
2 parents 8f60547 + 08e3f28
commit df3662a
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 11 deletions.
diff --git a/INSTALL-McStas/conda/README.md b/INSTALL-McStas/conda/README.md
@@ -7,14 +7,21 @@ Due to the complex [licensing situation](https://discuss.scientific-python.org/t
 * [miniforge](https://github.com/conda-forge/miniforge) or
 * [micromamba](https://mamba.readthedocs.io/en/latest/user_guide/micromamba.html)
 
-## Optionally create a dedicated environment and load it
+## If you ALREADY have a conda (be it Anaconda, blah-conda or whatever)
+* Initially, list mcstas versions available on conda-forge, just to be sure you pick them up:
+* ```conda search mcstas --channel conda-forge```, should give you many lines of the form
+* ```mcstas                         3.5.8      hce30654_1  conda-forge   ```
+* To install McStas with all needed dependencies, run
+* ```conda create --name mcstas --channel conda-forge --channel nodefaults mcstas```
+
+## If you DON'T have a conda already:
+
+### Optionally create a dedicated environment and load it
 * ```conda create --name mcstas ```
 * ```conda activate mcstas```
 
-## Install McStas, compilers, openmpi
-* ```mamba install mcstas compilers openmpi=4```
-
-(From next McStas release newer openmpi versions are also OK, but the 3.5.1 version of mcrun has an issue with openmpi 5.x)
+### Install McStas, compilers, openmpi
+* ```mamba install mcstas```
 
 ## Note for use on Windows
 At the time of release for 3.5.1 MCPL and NCrystal are not yet available for Windows on conda-forge, so related instruments will not compile/function.

diff --git a/INSTALL-McXtrace/conda/README.md b/INSTALL-McXtrace/conda/README.md
@@ -7,15 +7,22 @@ Due to the complex [licensing situation](https://discuss.scientific-python.org/t
 * [miniforge](https://github.com/conda-forge/miniforge) or
 * [micromamba](https://mamba.readthedocs.io/en/latest/user_guide/micromamba.html)
 
-## Optionally create a dedicated environment and load it
+## If you ALREADY have a conda (be it Anaconda, blah-conda or whatever)
+* Initially, list mcstas versions available on conda-forge, just to be sure you pick them up:
+* ```conda search mcxtrace --channel conda-forge```, should give you many lines of the form
+* ```mcxtrace                         3.5.8      hce30654_1  conda-forge   ```
+* To install McStrace with all needed dependencies, run
+* ```conda create --name mcxtrace --channel conda-forge --channel nodefaults mcxtrace```
+
+## If you DON'T have a conda already:
+
+### Optionally create a dedicated environment and load it
 * ```conda create --name mcxtrace ```
 * ```conda activate mcxtrace```
 
-## Install McXtrace, compilers, openmpi
-* ```mamba install mcxtrace compilers openmpi=4```
-
-(From next McXtrace release newer openmpi versions are also OK, but the 3.5.1 version of mcrun has an issue with openmpi 5.x)
-
+### Install McStas, compilers, openmpi
+* ```mamba install mcxtrace```
+
 ## Note for use on Windows
 At the time of release for 3.5.1 MCPL is notr yet available for Windows on conda-forge, so related instruments will not compile/function.
 We expect this dependency to become available during the fall/winter of 2024.