Skip to content

Commit b9db18f

Browse files
committed
Update developer instructions for Julia and RMS steps.
Users need to run install_rms.sh then follow its instructions then run it again. Also made a one-liner test that RMS is installed (though carefully avoid the many minutes of pre-compiling)
1 parent 774115b commit b9db18f

2 files changed

Lines changed: 12 additions & 5 deletions

File tree

documentation/source/users/rmg/installation/anacondaDeveloper.rst

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -102,14 +102,19 @@ Installation by Source Using Anaconda Environment for Unix-based Systems: Linux
102102

103103
Be sure to either close and reopen your terminal to refresh your environment variables (``source ~/.bashrc`` or ``source ~/.zshrc``).
104104

105-
#. **Optional (Recommended)**: Install and Link Julia dependencies using ``install_rms.sh``. Ensure that you have modified your environment variables as described above, and then run the following: ::
105+
#. **Optional (Recommended)**: Install and Link Julia dependencies.
106+
107+
Installing Julia and ReactionMechanismSimulator.jl (RMS) will enable all the features in RMG that require RMS-based reactors,
108+
as well as using ``method='ode'`` when solving the Master Equation with Arkane.
109+
Note that installing RMS can cause errors when running Cantera simulations; this should not affect normal RMG use, but if you wish to run Cantera simulations you will need to maintain a separate conda environment without RMS in it.
110+
111+
Ensure that you have modified your environment variables as described above, and then run the following: ::
106112

107113
source install_rms.sh
108114

109-
Follow the final set of instructions from this installation script with regard to setting additional environment variables.
110-
Installing RMS will allow using ``method='ode'`` when solving the Master Equation with Arkane and using ``ReactionMechanismSimulator.jl``-based reactors in RMG.
111-
Note that installing RMS will cause errors when running Cantera simulations.
112-
This should not affect normal RMG use, but if you wish to run Cantera simulations you will need to maintain a separate ``rmg_env`` without RMS in it.
115+
Follow the instructions that it provides for installing Julia and Juliaup,
116+
which can involve several steps including restarting your terminal or shell.
117+
Run the script again, until it finishes installing RMS and all of its dependencies, and reports that ReactionMechanismSimulator is installed.
113118

114119
#. Finally, you can run RMG from any location by typing the following (given that you have prepared the input file as ``input.py`` in the current folder). ::
115120

install_rms.sh

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,3 +54,5 @@ conda activate $current_env
5454
conda install -y conda-forge::pyjuliacall
5555

5656
julia -e 'using Pkg; Pkg.add(Pkg.PackageSpec(name="ReactionMechanismSimulator", url="https://github.com/hwpang/ReactionMechanismSimulator.jl.git", rev="fix_installation")); using ReactionMechanismSimulator; Pkg.instantiate()' || echo "RMS install error - continuing anyway ¯\_(ツ)_/¯"
57+
58+
python -c "from juliacall import Main; import sys; sys.exit(0 if Main.seval('Base.identify_package(\"ReactionMechanismSimulator\") !== nothing') and print('ReactionMechanismSimulator is installed in $current_env') is None else 1)"

0 commit comments

Comments
 (0)