Skip to content

Commit 325ae37

Browse files
committed
Add instructions for the new install_rms.sh script.
I'm sure could be better written, but this is better than nothing. I also fixed a small bug that sphinx was complaining about in the releaseNotes
1 parent f19d292 commit 325ae37

2 files changed

Lines changed: 21 additions & 2 deletions

File tree

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

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,25 @@ Installation by Source Using Anaconda Environment for Unix-based Systems: Linux
129129
which can involve several steps including restarting your terminal or shell.
130130
Run the script again, until it finishes installing RMS and all of its dependencies, and reports that ReactionMechanismSimulator is installed.
131131

132+
**Advanced Usage**:
133+
The ``install_rms.sh`` script has options, that can be set as environment variables or variables to the script.
134+
By default, it installs the latest release of the ``for_rmg`` branch of RMS, from https://github.com/ReactionMechanismGenerator/ReactionMechanismSimulator.jl/branches, which is recommended for most users.
135+
To install a different branch (from the same github repository) specify ``RMS_BRANCH``.
136+
The default installation mode is ``standard``, which prompts the user to confirm their conda environment.
137+
In an automated workflow (eg. CI/CD), you may wish to set ``RMS_INSTALLER`` to ``continuous`` to skip the prompt.
138+
If you set ``RMS_INSTALLER`` to ``developer`` then it will link to a local version of RMS,
139+
so you must also specify ``RMS_PATH`` to point to your local clone of the ReactionMechanismSimulator.jl repository.
140+
Exmaple usage: ::
141+
142+
export RMS_BRANCH=for_rmg
143+
export RMS_INSTALLER=continuous
144+
source install_rms.sh
145+
146+
or ::
147+
148+
RMS_INSTALLER=developer RMS_PATH=$HOME/Code/ReactionMechanismSimulator.jl source install_rms.sh
149+
150+
132151
#. 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). ::
133152

134153
python replace/with/path/to/rmg.py input.py

documentation/source/users/rmg/releaseNotes.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ RMG-Py Version 3.3.0
88
====================
99
Date: July 10, 2025
1010

11-
The below list is a summary. For a complete list of all changes, see the `Official Release Page <https://github.com/ReactionMechanismGenerator/RMG-Py/releases/tag/3.3.0>`_.
11+
The below list is a summary. For a complete list of all changes, see the `Official RMG-Py Release Page <https://github.com/ReactionMechanismGenerator/RMG-Py/releases/tag/3.3.0>`_.
1212

1313
- Software Improvements
1414
- RMG-Py now uses Python 3.9
@@ -33,7 +33,7 @@ RMG-Database Version 3.3.0
3333
==========================
3434
Date: July 10, 2025
3535

36-
The below list is a summary. For a complete list of all changes, see the `Official Release Page <https://github.com/ReactionMechanismGenerator/RMG-database/releases/tag/3.3.0>`_.
36+
The below list is a summary. For a complete list of all changes, see the `Official RMG-Database Release Page <https://github.com/ReactionMechanismGenerator/RMG-database/releases/tag/3.3.0>`_.
3737

3838
- Features
3939
- Electrochemistry with Lithium

0 commit comments

Comments
 (0)