diff --git a/.conda/meta.yaml b/.conda/meta.yaml index a28f6ed433..70826ca923 100644 --- a/.conda/meta.yaml +++ b/.conda/meta.yaml @@ -9,7 +9,7 @@ # package: name: rmg - version: 4.0.0.rc1 + version: 4.0.0 source: path: ../ @@ -68,7 +68,7 @@ requirements: - rmg::pydas >=1.0.3 - rmg::pydqed >=1.0.3 - rmg::symmetry - - rmg::rmgdatabase =4.0.0.rc1 + - rmg::rmgdatabase =4.0.0 - blas=*=openblas run: *runtime_requirements test: diff --git a/documentation/source/users/rmg/installation/anacondaUser.rst b/documentation/source/users/rmg/installation/anacondaUser.rst index 2d31437543..01ae81655b 100644 --- a/documentation/source/users/rmg/installation/anacondaUser.rst +++ b/documentation/source/users/rmg/installation/anacondaUser.rst @@ -19,7 +19,7 @@ Binary Installation Using Anaconda for Unix-Based Systems: Linux and Mac OSX To install a specific version of RMG, add the version to the install command:: - conda create --name rmg_33_env -c conda-forge -c rmg 'rmg==4.0.0.rc1' + conda create --name rmg_33_env -c conda-forge -c rmg 'rmg==4.0.0' Not all versions of RMG are available via conda for all platforms. Check the `official RMG conda channel `_ to see which are available for download. diff --git a/documentation/source/users/rmg/installation/index.rst b/documentation/source/users/rmg/installation/index.rst index b3831475d8..70a2b743f4 100644 --- a/documentation/source/users/rmg/installation/index.rst +++ b/documentation/source/users/rmg/installation/index.rst @@ -16,17 +16,17 @@ RMG is primarily distributed using Docker, a software package for delivering app #. Download and install `Docker `_. -#. Open a terminal, powershell, or command prompt and run ``docker pull reactionmechanismgenerator/rmg:4.0.0.rc1``. +#. Open a terminal, powershell, or command prompt and run ``docker pull reactionmechanismgenerator/rmg:4.0.0``. This step may take some time as the image is downloaded. -#. Run ``docker run --name rmgcontainer -v "C:\Users\rmguser\myrmgfiles:/rmg/RMG-Py/myrmgfiles" -it reactionmechanismgenerator/rmg:4.0.0.rc1`` +#. Run ``docker run --name rmgcontainer -v "C:\Users\rmguser\myrmgfiles:/rmg/RMG-Py/myrmgfiles" -it reactionmechanismgenerator/rmg:4.0.0`` This command will make the folder ``C:\Users\rmguser\myrmgfiles`` on your computer accessible from inside the container to easily edit and transfer input and output files. Change the path to match your individual computer. If the folder does not exist when the command is run, it will be created. - If you want to use jupyter notebook inside the docker container, run ``docker run --name rmgcontainer -v "C:\Users\rmguser\myrmgfiles:/rmg/RMG-Py/myrmgfiles" -it -p 8888:8888 reactionmechanismgenerator/rmg:4.0.0.rc1`` instead. + If you want to use jupyter notebook inside the docker container, run ``docker run --name rmgcontainer -v "C:\Users\rmguser\myrmgfiles:/rmg/RMG-Py/myrmgfiles" -it -p 8888:8888 reactionmechanismgenerator/rmg:4.0.0`` instead. And you can start the jupyter notebook by running ``jupyter notebook --ip 0.0.0.0 --no-browser --allow-root`` inside the container. Then you can access the jupyter notebook from your browser by going to ``http://localhost:8888``. You may need to copy and paste the token from the terminal into the browser to access the notebook. @@ -40,7 +40,7 @@ For users unfamiliar with bash or Linux, we recommend looking at `Must Know Linux/Unix Commands `_. .. NOTE:: - The docker instructions above which specify ``rmg:4.0.0.rc1`` are for the version 4.0.0.rc1 release of RMG-Py (April 2026), the user guide for which is archived in a `4mb PDF here `_. + The docker instructions above which specify ``rmg:4.0.0`` are for the version 4.0.0 release of RMG-Py (April 2026), 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. diff --git a/documentation/source/users/rmg/releaseNotes.rst b/documentation/source/users/rmg/releaseNotes.rst index b004a4c2e2..a7a0fa6e63 100644 --- a/documentation/source/users/rmg/releaseNotes.rst +++ b/documentation/source/users/rmg/releaseNotes.rst @@ -4,17 +4,52 @@ Release Notes ************* -RMG-Py Version 4.0.0.rc1 +RMG-Py Version 4.0.0 ==================== -Date: April 24, 2026 +Date: June 10, 2026 -TODO: fill out +The below list is a summary. For a complete list of all changes, see the `Official RMG-Py Release Page `_. -RMG-Database Version 4.0.0.rc1 +- Software Improvements + - Upgraded core dependencies to Cantera 3 and Python 3.11/updated ecosystem + - Optimizations to Cython declarations and molecule module structures + - Incremental Cython builds restored in the Makefile for faster developer compilation + - Jupyter Notebooks updated to interface with Reaction Mechanism Simulator (RMS) using `juliacall` + - Enhanced CI pipelines with updated macOS runner images, Node.js 24 actions, Miniforge + +- Bug Fixes + - Improved RDKit `GetSSSR` non-determinism + - Fixed duplicate reactions from identical templates being erroneously added to mechanisms + - Fixed error handling for pressure-dependent reaction deep-copies and $E_0$ energy corrections + - Corrected constant-species index mapping in `SimpleReactor` + - Removed deprecated `imp.load_source` calls and eliminated unreachable code segments + +- New Features + - Introduced an auto-database feature and a new YAML file writer + - Introduced multi-part Uncertainty analysis suite, including covariance matrix exports and quadrature integration + - Added comprehensive surface sensitivity features for `SurfaceReactor` + - Added support for coverage-dependent thermochemistry and kinetics for surface catalysis + - Added an Arkane xTB Electronic Structure Software (ESS) adapter + - Implemented a species constraint setting for specifying the maximum number of fused rings allowed + + +RMG-Database Version 4.0.0 ========================== -Date: April 24, 2026 +Date: June 10, 2026 + +The below list is a summary. For a complete list of all changes, see the `Official RMG-Database Release Page `_. -TODO: fill out +- Features + - Added data for electrocatalytic $\text{CO}_2$ reduction ($\text{CO}_2\text{RR}$) kinetics and adsorbates + - Implemented new surface nitrogen reaction families, BEP rules, and NOx chemistry for $\text{Pt}(111)$ + - Added BEEF uncertainty covariance data support + - Expanded datasets with a new Formic Acid library and example coverage-dependent thermo libraries + - Introduced a `recommended_libraries.yml` configuration file + +- Bugfixes + - Fixed thermodynamic discontinuity issues found in the formic acid dataset + - Corrected temperature minimum settings ($T_{min}$) from 300 K to 298 K in NASA polynomials for $\text{CO}_2\text{RR}$ adsorbates on $\text{Ag}(111)$ + - Fixed incorrect entry details in the `Glarborg/C2` database RMG-Py Version 3.3.0 ==================== diff --git a/rmgpy/version.py b/rmgpy/version.py index 5cbd65179b..3f47af345d 100644 --- a/rmgpy/version.py +++ b/rmgpy/version.py @@ -33,4 +33,4 @@ This value can be accessed via `rmgpy.__version__`. """ -__version__ = '4.0.0.rc1' +__version__ = '4.0.0'