-
Notifications
You must be signed in to change notification settings - Fork 227
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update the README to be more clean and include more information
- Loading branch information
Showing
1 changed file
with
39 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,39 +1,58 @@ | ||
| # <img align="top" src="https://github.com/raw/ReactionMechanismGenerator/RMG-Py/master/documentation/source/_static/rmg-logo-small.png"> RMG Py - Reaction Mechanism Generator (Python Version) | ||
| # <img align="top" src="https://github.com/raw/ReactionMechanismGenerator/RMG-Py/master/documentation/source/_static/rmg-logo-small.png"> Reaction Mechanism Generator (RMG) | ||
|
|
||
| This repository contains the Python version of Reaction Mechanism Generator | ||
| (RMG), a tool for automatically generating chemical reaction | ||
| ## Description | ||
| This repository contains the Python version of **Reaction Mechanism Generator (RMG)**, | ||
| a tool for automatically generating chemical reaction | ||
| mechanisms for modeling reaction systems including pyrolysis, combustion, | ||
| atmospheric science, and more. | ||
|
|
||
| It also includes CanTherm, the package for calculating thermodynamics, high-pressure-limit | ||
| It also includes **CanTherm**, the package for calculating thermodynamics, high-pressure-limit | ||
| rate coefficients, and pressure dependent rate coefficients from quantum chemical calculations. | ||
| CanTherm is compatible with a variety of ab initio quantum chemistry software programs, including but not limited to | ||
| Gaussian, MOPAC, QChem, and MOLPRO. | ||
|
|
||
| The most official repository can be found on github and is located at https://github.com/ReactionMechanismGenerator/RMG-Py. | ||
| Instructions on how to use RMG can be found in the [RMG Documentation](http://ReactionMechanismGenerator.github.io/RMG-Py/) including | ||
| details on [how to install RMG-Py](http://ReactionMechanismGenerator.github.io/RMG-Py/users/rmg/installation/index.html) | ||
| and its numerous dependencies. The [CanTherm Documentation](http://ReactionMechanismGenerator.github.io/RMG-Py/users/cantherm/) is also available online. | ||
| PDF versions of all the documentation can also be found in the documentation folder of the source code. | ||
| ## Source Code Repository | ||
| - [RMG Github Repository](https://github.com/ReactionMechanismGenerator/RMG-Py): contains the latest source code for RMG | ||
| - [RMG-database Github Repository](https://github.com/ReactionMechanismGenerator/RMG-database): contains source code for the latest version of the database | ||
|
|
||
| ## Latest Stable Release | ||
| **RMG v1.0.2** | ||
|
|
||
| View the [Release Notes](http://reactionmechanismgenerator.github.io/RMG-Py/users/rmg/releaseNotes.html). | ||
|
|
||
| RMG is developed primarily by researchers in | ||
| [Prof. William Green's research group](http://cheme.scripts.mit.edu/green-group/) at the | ||
| ## How to Install | ||
| View the [Download and Install](http://reactionmechanismgenerator.github.io/RMG-Py/users/rmg/installation/index.html) page. | ||
|
|
||
| ## Documentation | ||
| - [RMG Documentation](http://ReactionMechanismGenerator.github.io/RMG-Py/) ([PDF version](https://github.com/ReactionMechanismGenerator/RMG-Py/raw/master/documentation/RMG-Py_and_CanTherm_Documentation.pdf)) | ||
| - [CanTherm Documentation](http://ReactionMechanismGenerator.github.io/RMG-Py/users/cantherm/) ([PDF version](https://github.com/ReactionMechanismGenerator/RMG-Py/raw/master/documentation/RMG-Py_and_CanTherm_Documentation.pdf)) | ||
| - [RMG API Reference](http://reactionmechanismgenerator.github.io/RMG-Py/reference/index.html) ([PDF version](https://github.com/ReactionMechanismGenerator/RMG-Py/raw/master/documentation/RMG-Py_API_Reference.pdf)) | ||
|
|
||
| Alternatively, PDF versions of all the documentation can also be found in the `documentation` folder of the source code. | ||
|
|
||
| ## Credits | ||
|
|
||
| - [Professor William H. Green's research group](http://cheme.scripts.mit.edu/green-group/) at the | ||
| [Massachusetts Institute of Technology](http://web.mit.edu/) | ||
| and [Prof. Richard West's research group](http://www.northeastern.edu/comocheng/) at | ||
| - [Professor Richard H. West's research group](http://www.northeastern.edu/comocheng/) at | ||
| [Northeastern University](http://www.northeastern.edu/). | ||
|
|
||
| ## How to Give Feedback | ||
|
|
||
| Please post any issues you may have to the [issues page](https://github.com/ReactionMechanismGenerator/RMG-Py/issues/) | ||
| or email [rmg_dev@mit.edu](mailto:rmg_dev@mit.edu) if you have questions. | ||
|
|
||
| ## Useful Links | ||
|
|
||
| - [Interactive Website](http://rmg.mit.edu): Visit this site to visualize RMG-generated models, view the databases, and | ||
| perform thermodynamics and kinetics searches | ||
| - [Wiki](https://github.com/ReactionMechanismGenerator/RMG-Py/wiki): a wiki for developer notes | ||
| - [Issues Page](https://github.com/ReactionMechanismGenerator/RMG-Py/issues/): view current issues and feature requests | ||
|
|
||
|
|
||
| ## Continuous Integration | ||
|
|
||
| We have a continuous integration build test suite | ||
| which you can access at https://travis-ci.org/ReactionMechanismGenerator/RMG-Py | ||
| The current build status is | ||
| [](https://travis-ci.org/ReactionMechanismGenerator/RMG-Py) | ||
|
|
||
| Details of the (earlier established) Java version of RMG can be found | ||
| on [Sourceforge](http://rmg.sourceforge.net/) (although it too is | ||
| developed [here on github](https://github.com/ReactionMechanismGenerator/RMG-Java/)). | ||
|
|
||
| Please post any issues you may have to the [issues page](https://github.com/ReactionMechanismGenerator/RMG-Py/issues/) | ||
| or email [rmg_dev@mit.edu](mailto:rmg_dev@mit.edu) if you have questions. | ||
|
|