Home

⚠️ Deprecation notice: The information provided here is out-of-date and may not apply to current versions of RMG. Documentation is currently being updated (see this PR). This page will be hidden in the near future. For up-to-date documentation, please access the Documentation.

Welcome to the Official RMG Wiki/Developer's Guide

The purpose of this wiki is to provide information relevant for developers not found in the documentation. For other information, please see the links below:

• Read the Documentation
• View the latest source code: Github Source Code
• Post issues and bugs on the Github Issues Page

Interactive Websites

• rmg.mit.edu: Visualize models, search for kinetics and thermochemistry, view the databases. etc.
• rmg.coe.neu.edu: Mirror of rmg.mit.edu, usually with older version, currently (2016-02-26) broken.

User Guides

• Transitioning from RMG 2 to RMG 3: Transition guide for updating from RMG 2 to RMG 3
• The main rmg user guide should contain information for how users should use software. If you have github pushing permissions, you can easily edit the documentation and commit it on the documentation branch from your web browser in this directory. You then can create a pull request to the master branch. This will provide better availability of your contribution.
• RMG Resources: A collection of resources on how to use RMG, Git, and other relevant topics, including past RMG study group presentations and RMG workshop recordings.

Developer Guides

• Adding Regression Tests: Tutorial for adding regression testing to the Continuous Integration.
• Next Generation RMG Ideas: Describe how RMG can be structured better in the future.
• RMG Contributor Guidelines: Process for contributing to RMG
• RMG code organization explanations: Explanations on the structure of RMG
• Programming Style Guide: How to capitalizeYourVariableNames etc.
• Git Commit Style Guide: How to write clean and pretty commit history.
• Setting up the RMG website as seen at http://rmg.mit.edu
• How to Update the Documentation available at http://reactionmechanismgenerator.github.io/RMG-Py/
• How to Package New Releases
• Simultaneous Update of RMG-Py and RMG-database

Anaconda

• Using and creating Anaconda environments
• Creating Anaconda binary packages
• Creating Anaconda binary packages for Windows