From 8b9035a851c3d55fa6b7563c21b5088dd06d7d8c Mon Sep 17 00:00:00 2001 From: Richard West Date: Wed, 4 Jun 2025 09:11:09 -0400 Subject: [PATCH 1/3] A note about installing developer version from Docker. The last Docker release was 2 years ago. Folks might want to use Docker to get a more recent version. Here is how. --- documentation/source/users/rmg/installation/index.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/documentation/source/users/rmg/installation/index.rst b/documentation/source/users/rmg/installation/index.rst index d15bc53482e..414b91694b1 100644 --- a/documentation/source/users/rmg/installation/index.rst +++ b/documentation/source/users/rmg/installation/index.rst @@ -39,6 +39,12 @@ For users unfamiliar with bash or Linux, we recommend looking at `Terminal vs File Manager `_, and `Must Know Linux/Unix Commands `_. +.. NOTE:: + The instructions above are for the release version 3.2.0 of RMG-Py (August 2023). + If you want to use the latest development version, you can replace the version number in the docker pull command with "latest" or omit it entirely. + For example, you can run ``docker pull reactionmechanismgenerator/rmg:latest`` or ``docker pull reactionmechanismgenerator/rmg`` to get the latest development version corresponding to `here `_. + Be sure to also change the version number in the docker run commands to match the version you pulled. + A full list of available docker images can be found at `Docker Hub `_. Alternative Install: Binary Installation Using Anaconda =========================================================== From 64a32578a21e71c059288daf6bc281f88f00ac32 Mon Sep 17 00:00:00 2001 From: Richard West Date: Wed, 11 Jun 2025 23:18:47 -0400 Subject: [PATCH 2/3] Update note with link to old 3.2.0 userguide. --- documentation/source/users/rmg/installation/index.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/documentation/source/users/rmg/installation/index.rst b/documentation/source/users/rmg/installation/index.rst index 414b91694b1..2d14df24ce6 100644 --- a/documentation/source/users/rmg/installation/index.rst +++ b/documentation/source/users/rmg/installation/index.rst @@ -40,9 +40,9 @@ For users unfamiliar with bash or Linux, we recommend looking at `Must Know Linux/Unix Commands `_. .. NOTE:: - The instructions above are for the release version 3.2.0 of RMG-Py (August 2023). - If you want to use the latest development version, you can replace the version number in the docker pull command with "latest" or omit it entirely. - For example, you can run ``docker pull reactionmechanismgenerator/rmg:latest`` or ``docker pull reactionmechanismgenerator/rmg`` to get the latest development version corresponding to `here `_. + The docker instructions above which specify ``rmg:3.2.0`` are for the version 3.2.0 release of RMG-Py (August 2023), the user guide for which is archived in a `4mb PDF here `_. + If you want to use the latest development version, which corresponds to the user guide you are reading online `on the RMG website `_, you can replace the version number in the docker pull command with "latest" or omit it entirely. + For example, you can run ``docker pull reactionmechanismgenerator/rmg:latest`` or ``docker pull reactionmechanismgenerator/rmg`` to get the latest development version corresponding to `the main branch `_. Be sure to also change the version number in the docker run commands to match the version you pulled. A full list of available docker images can be found at `Docker Hub `_. From 45f8d9b5843061a20b1b2ef3d59682e91f67f471 Mon Sep 17 00:00:00 2001 From: Richard West Date: Wed, 11 Jun 2025 23:47:31 -0400 Subject: [PATCH 3/3] Remove/hide Anaconda binary installation instructions. Since we haven't pushed conda binaries in over four years, (5.5 years for mac and 7 years for windows) we should stop telling people it's the recommended Alternative Install to Docker. The only viable option besides docker is currently to build from source. We should update these instructions again once we get conda build working and make a new release! --- documentation/source/users/rmg/faq.rst | 3 +-- .../source/users/rmg/installation/index.rst | 22 +++++-------------- 2 files changed, 7 insertions(+), 18 deletions(-) diff --git a/documentation/source/users/rmg/faq.rst b/documentation/source/users/rmg/faq.rst index aa950a8d70b..714ea9105aa 100644 --- a/documentation/source/users/rmg/faq.rst +++ b/documentation/source/users/rmg/faq.rst @@ -28,8 +28,7 @@ Running RMG #. **How do I run a basic RMG job?** - Please see step-by-step instructions in the either the :ref:`binary` or :ref:`source ` - installation instructions. In general, the syntax is :: + Please see step-by-step instructions in the installation instructions. In general, the syntax is :: rmg.py input.py diff --git a/documentation/source/users/rmg/installation/index.rst b/documentation/source/users/rmg/installation/index.rst index 2d14df24ce6..78be9d3ee45 100644 --- a/documentation/source/users/rmg/installation/index.rst +++ b/documentation/source/users/rmg/installation/index.rst @@ -46,26 +46,15 @@ For users unfamiliar with bash or Linux, we recommend looking at Be sure to also change the version number in the docker run commands to match the version you pulled. A full list of available docker images can be found at `Docker Hub `_. -Alternative Install: Binary Installation Using Anaconda -=========================================================== - -If you are accustomed to using the Anaconda package manager or cannot tolerate the storage overhead of Docker, installation from conda is also available. -This is recommended for users who want to use RMG out of the box and are not interested in changing the RMG code or making many additions to RMG's thermodynamic and kinetics databases. -If this does interest you, please see the Developer Install below. - -.. toctree:: - :maxdepth: 1 - - anacondaUser - Developer Install: Installation from Source =========================================================== -RMG-Py can now be built by source using the Anaconda Python Platform to assist in installing -all necessary dependencies. This is recommended for a developer who may be altering the RMG source code -or someone who expects to manipulate the databases extensively. You will also be able to access the latest -source code updates and patches through Github. +RMG-Py can be built from source using the Anaconda Python Platform to assist in installing all necessary dependencies. +This is recommended for a developer who may be altering the RMG source code or someone who expects to manipulate the databases extensively. +You will also be able to access the latest source code updates and patches through Github. +It is also currently the only option to avoid the storage and memory overhead of Docker. +Installation by Conda without compiling from source is limited to `older versions of RMG-Py `_ and is not currently recommended (but would follow instructions below if you needed). .. toctree:: :maxdepth: 1 @@ -85,6 +74,7 @@ not recommended for use. linux macos + anacondaUser anacondaUserWindows anacondaDeveloperWindows windowsEnvironment