You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The **RMG-database** is a separate repository containing all thermodynamic, kinetics, and transport data. It's typically cloned alongside RMG-Py in a sibling folder named `RMG-database`.
74
74
75
-
### Database Structure (in RMG-database repo)
75
+
### Database Structure (in RMG-database `input/` directory, eg. `RMG-database/input/thermo/`)
76
76
-`thermo/` - Thermodynamic libraries and group additivity data
77
77
-`kinetics/families/` - Reaction family templates with rate rules (e.g., `H_Abstraction`, `R_Addition_MultipleBond`)
2.`thermoengine` dispatches to the loaded `ThermoDatabase` and ultimately calls `ThermoDatabase.get_thermo_data(species)`
104
+
3.`ThermoDatabase` first checks thermo libraries for an exact match (via graph isomorphism)
105
+
4. If no library match is found, `ThermoDatabase` falls back to group additivity estimation using functional group contributions
106
+
5. The resolved result is returned as a `ThermoData`, `NASA`, or `Wilhoit` object
107
+
106
108
107
109
### Data Flow for Reaction Kinetics
108
110
1.`KineticsFamily.generate_reactions(reactants)` - Matches reactant molecules to family templates
@@ -111,7 +113,7 @@ database.load(
111
113
4. Returns `Arrhenius` or pressure-dependent kinetics model
112
114
113
115
## External Dependencies
114
-
-**RMG-database**: Set location via `RMG_DATABASE_BRANCH` env var in CI, or pass path to `database.load()`
116
+
-**RMG-database**: In CI, `RMG_DATABASE_BRANCH` controls which RMG-database branch is cloned. Locally, the database location is set via `settings['database.directory']` (default `../RMG-database/input`) or `database.directory`in an `rmgrc` file; you may also pass an explicit path to `database.load()`.
115
117
-**Julia/RMS**: Optional (recommended) reactor simulation backend (install via `./install_rms.sh`)
116
118
- Environment managed via `environment.yml` (conda/mamba)
117
119
@@ -125,18 +127,18 @@ Documentation lives in `documentation/source/` and is built with Sphinx (`make d
125
127
126
128
### API Reference (`documentation/source/reference/`)
127
129
- Auto-generated from docstrings using `sphinx.ext.autodoc`
128
-
- Each module has a corresponding `.rst` file (e.g., `reference/species/index.rst` → `rmgpy/species.py`)
130
+
- Each module has a corresponding `.rst` file (e.g., `documentation/source/reference/species/index.rst` → `rmgpy/species.py`)
129
131
-**Maintenance**: Add new modules to the appropriate `index.rst` toctree. Docstrings in code are automatically extracted.
130
132
- Uses reStructuredText format with `.. automodule::` directives
0 commit comments