Skip to content

Commit 3f4b028

Browse files
committed
RMG-Py v2.1.3 release
2 parents bd5fcca + 1cebdf6 commit 3f4b028

File tree

303 files changed

+131445
-6465
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

303 files changed

+131445
-6465
lines changed

.travis.yml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ env:
88
global:
99
- secure: "L2ja+ZnV83w4qG3E8FwTjm0D6IWNOnj5wuFOjYTwbzQP4OAgLAWBzCMtxzWy5sMxFLtRgkswBH1d5f5kg8Ab7GIyAMFgQwe8UFqMJ+N05QNszE1mJkAvJtv2XN7669XXQhTt5EXfHrCcGZaODVnI2CEA8GB5DxiHO2Lcqf/xvgE="
1010
- secure: "Fa/qcHKKkTzgNanhgz+XWXg5K+uae5Ukxd0hfzYaiOI4+ldFbyMrYbPpxxoYVXw1SSO0psSupLfPfXzHwyJpFOyc46P+fo+R3YgNTJwr2VfdvSC0bp9K01nlRJ/z62IpMwmDwR2UH5xnfTeB9nhtzviFNKZoDZ/GR7F1Wqd/nnU="
11+
- secure: "dkhvrkbNEHv55q3NU+lNJ0SqaNG0/vPMsG3X2eQvYjFsq/e8EliILtEtjrugSgeFohxqms0F+sSyDpw46mtn+jukYejdywLVL7w8o9pxlkHv8uEqYhNiwCD8RjNyRPQAS9jL+sAJiqdqUWR6AzjwaLproCe6rFzzGe7Io5oDLMg="
12+
- secure: "cfosGf5hvUhIlPoGJu0d/HFddrMwIFU7FfLwd8yRrMGkYv0ePOwAW9kmhFSxUYvuXkxzgD75cIICMFY2fSm6VXBXXzfPQD7vwzoApXf7a8vi0C64XhinXhdEyUYb5/v8fswa0zheUENYhUS1tOqDXT/h8EPNZT5wKizaA3O2Wa8="
13+
- secure: "QXuqKYuwCocqsTMePBc5OugBbQC4/t+335TYLdkletiateP/rF/eDsVRG792/BVq5gKRZgz3NH9ipTNm5pZoCbAEPt9+eDpfts8WeAbxmjdcEjfBxxwZ69wUTPAVrezTGn2k7W2UBdFrWeUNKPAVCKIkoviXqOHFitqJEC+c6JY="
14+
- secure: "jIyBEzR10l5SWvY5ouEYzA8YzPHIZNMXMBdcXwuwte8NCU8GBYUqhHA1L67nTaBdLhWbrZ2NireVKPQWJp3ctcI0IB6xZzaYlVpgN/udGPO+1MZd9Xhp9TWuJWrGZ9EoWGB9L5H+O7RYwcDMVH5CUrCIBdsSJuyE8aDpky1/IVE="
1115
addons:
1216
apt:
1317
packages:
@@ -33,7 +37,7 @@ install:
3337
- make
3438

3539
script:
36-
- make test
40+
- make test-all
3741
- make test-database
3842

3943
after_success:
File renamed without changes.

Makefile

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,17 +74,32 @@ decython:
7474
find . -name *.so ! \( -name _statmech.so -o -name quantity.so -o -regex '.*rmgpy/solver/.*' \) -exec rm -f '{}' \;
7575
find . -name *.pyc -exec rm -f '{}' \;
7676

77-
test:
77+
test-all:
7878
ifeq ($(OS),Windows_NT)
7979
nosetests --nocapture --nologcapture --all-modules --verbose --with-coverage --cover-inclusive --cover-package=rmgpy --cover-erase --cover-html --cover-html-dir=testing/coverage --exe rmgpy
8080
else
8181
mkdir -p testing/coverage
8282
rm -rf testing/coverage/*
8383
nosetests --nocapture --nologcapture --all-modules --verbose --with-coverage --cover-inclusive --cover-package=rmgpy --cover-erase --cover-html --cover-html-dir=testing/coverage --exe rmgpy
8484
endif
85+
86+
test:
87+
ifeq ($(OS),Windows_NT)
88+
nosetests --nocapture --nologcapture --all-modules --attr '!auth' --verbose --with-coverage --cover-inclusive --cover-package=rmgpy --cover-erase --cover-html --cover-html-dir=testing/coverage --exe rmgpy
89+
else
90+
mkdir -p testing/coverage
91+
rm -rf testing/coverage/*
92+
nosetests --nocapture --nologcapture --all-modules --attr '!auth' --verbose --with-coverage --cover-inclusive --cover-package=rmgpy --cover-erase --cover-html --cover-html-dir=testing/coverage --exe rmgpy
93+
endif
94+
8595
test-database:
8696
nosetests -v -d testing/databaseTest.py
87-
97+
eg0: noQM
98+
mkdir -p testing/eg0
99+
rm -rf testing/eg0/*
100+
cp examples/rmg/superminimal/input.py testing/eg0/input.py
101+
@ echo "Running eg0: superminimal (H2 oxidation) example"
102+
python rmg.py testing/eg0/input.py
88103
eg1: noQM
89104
mkdir -p testing/eg1
90105
rm -rf testing/eg1/*

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Gaussian, MOPAC, QChem, and MOLPRO.
1717
- [RMG-database Github Repository](https://github.com/ReactionMechanismGenerator/RMG-database): contains source code for the latest version of the database
1818

1919
## Latest Stable Release
20-
**RMG v2.1.2**
20+
**RMG v2.1.3**
2121
[![Anaconda-Server Badge](https://anaconda.org/rmg/rmg/badges/version.svg)](https://anaconda.org/rmg/rmg)
2222

2323
View the [Release Notes](http://reactionmechanismgenerator.github.io/RMG-Py/users/rmg/releaseNotes.html).

deploy.sh

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,4 +75,7 @@ git checkout $RMGTESTSBRANCH
7575
git commit --allow-empty -m rmgpy-$REV
7676

7777
# push to the branch to the RMG/RMG-tests repo:
78-
git push -f $REPO $RMGTESTSBRANCH > /dev/null
78+
git push -f $REPO $RMGTESTSBRANCH > /dev/null
79+
80+
# kill ssh-agent if neccessary
81+
ssh-agent -k
28.3 KB
Loading

documentation/source/users/cantherm/input.rst

Lines changed: 478 additions & 84 deletions
Large diffs are not rendered by default.

documentation/source/users/cantherm/input_pdep.rst

Lines changed: 504 additions & 95 deletions
Large diffs are not rendered by default.

documentation/source/users/cantherm/installation.rst

Lines changed: 7 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -2,61 +2,15 @@
22
Installation
33
************
44

5-
Dependencies
6-
============
7-
8-
Python versions 2.6+ are recommended for CanTherm. Currently Python 3.x versions
9-
are incompatible with CanTherm.
10-
11-
CanTherm relies on a number of Python packages for certain functionality. The
12-
following lists the required Python packages that are not part of the Python
13-
standard library:
14-
15-
* `NumPy <http://www.numpy.org>`_. Provides efficient array and matrix
16-
operations.
17-
18-
* `SciPy <http://www.scipy.org>`_. Provides efficient linear algebra functions
19-
and special functions.
20-
21-
* `Cython v0.19+ <http://www.cython.org>`_. C-extensions for Python
22-
23-
* `RDKit <http://www.rdkit.org>`_. Cheminformatics libraries and functions
24-
25-
* `Cairo <http://cairographics.org/>`_. Cairo graphics rendering for Python for drawing reaction networks
26-
27-
* Quantities. For converting between different scientific units
28-
29-
* Argparse. For parsing input arguments when running scripts
30-
31-
You can install these dependencies on Linux in the following fashion. ::
32-
33-
sudo apt-get install python-numpy python-scipy python-cairo
34-
sudo pip install cython>=0.19 quantities argparse
35-
36-
It is recommended that RDKit be installed manually with InChI capabilities on.
37-
38-
395
Installing CanTherm
406
===================
417

42-
Once you have obtained the required dependencies, CanTherm can be installed by
43-
first obtaining the RMG-Py source code by either downloading into a directory using git::
44-
45-
git clone git@github.com:ReactionMechanismGenerator/RMG-Py.git
46-
47-
or by downloading the zip file of the current RMG-Py master source code found
48-
`here <https://github.com/ReactionMechanismGenerator/RMG-Py/archive/master.zip>`_ and unzipping into
49-
the appropriate directory.
50-
51-
Inside the root package directory for ``RMG-Py``, execute the following make command::
52-
53-
make cantherm
54-
55-
The appropriate cythonization and compilation steps will now begin. When they are completed,
56-
you can run a test example by going into the examples folder to run a sample Cantherm job
57-
to verify the installation::
8+
CanTherm can be obtained by installing the `RMG-Py <http://rmg.mit.edu/>`_ software, which
9+
includes all neccesary dependancies.
5810

59-
cd examples/cantherm/networks/acetyl+O2
60-
python ../../../../cantherm.py input.py
11+
Instructions to install RMG-Py can be found at the :ref:`RMG-Py Installation page <installation>`.
6112

62-
This will allow you to use the cantherm.py as a Python script anytime you point to it.
13+
Note that you'll need to choose between the Basic User or Developer installation instructions
14+
that are specific to your operating system. Modifying cantherm source code will
15+
require Developer installation. If you are only looking to run the code, the
16+
Basic User installation will work.

documentation/source/users/cantherm/introduction.rst

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,16 @@ one-dimensional master equation, then apply one of several available model
1717
reduction methods of varying accuracy, speed, and robustness to simplify the
1818
detailed model into a set of phenomenological rate coefficients. The result
1919
is a set of :math:`k(T,P)` functions suitable for use in chemical reaction
20-
mechanisms.
20+
mechanisms. More information is available at `Allen et al. <http://dx.doi.org/10.1039/c1cp22765c>`_.
2121

22-
23-
About CanTherm
24-
==============
22+
CanTherm is developed and distributed as part of `RMG-Py <http://rmg.mit.edu/>`_, but can be used as a stand-alone
23+
application for Thermochemistry, Transition State Theory, and Master Equation chemical kinetics calculations.
2524

2625
CanTherm is written in the `Python <http://www.python.org/>`_ programming
27-
language to facilitate ease of development, installation, and use.
26+
language to facilitate ease of development, installation, and use.
27+
28+
Additional theoretical background can be found at `RMG's Theory Guide <http://reactionmechanismgenerator.github.io/RMG-Py/theory/index.html>`_
29+
and `CanTherm's Manual <manual.pdf>`_ as well as the `manual's supplement information <manual_supplement-Solving1DSchrodingerEquation.pdf>`_.
2830

2931
License
3032
=======
@@ -35,4 +37,4 @@ full, official license is reproduced below
3537

3638

3739

38-
.. literalinclude:: ../../../../COPYING.txt
40+
.. literalinclude:: ../../../../LICENSE.txt

0 commit comments

Comments
 (0)