Skip to content

Commit

Permalink
Adding docs
Browse files Browse the repository at this point in the history
  • Loading branch information
David Topping authored and David Topping committed May 23, 2018
1 parent e7201c2 commit e0271d4
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This project is licensed under the terms of the GNU General Public License v3.0,

# Table of contents
1. [Model overview](#Model-overview)
2. [Dependencies](#Dependencies)
2. [Dependencies and installation](#Dependencies)
3. [Folder structure and running the model](#Folder-Structure)
4. [Unit Tests](#Automated-unit-tests)
5. [Contributing](#Contributing)
Expand All @@ -29,7 +29,7 @@ PyBox works on the basis of reading a file that defines reactions between compou

Where the equation number is defined first, then the reactants/products along with a defined rate coefficient. This equation file is parsed by functions in 'Parse_eqn_file.py', providing information that can be used to set up and solve the relevant ordinary differential equations (ODEs) to simulate the evolution of the chemical mechanism. Each component in this chemical mechanism also has an associated record of chemical structure in the form of a [SMILES string](http://www.daylight.com/dayhtml/doc/theory/theory.smiles.html). This information is carried in a .xml file, provided by the MCM, and stored in the root directory of PyBox. Why is this important? Well, this information is taken by the [UManSysProp](http://umansysprop.seaes.manchester.ac.uk) informatics suite and allows us to predict properties of each compound that helps us predict whether they are likely to remain in the gas phase or condense to an existing particulate phase through gas-to-particle partitioning. Before we take a look at the directory structure provided in this repository, lets deal with the dependencies.

## Dependencies<a name="Dependencies"></a>
## Dependencies and installation <a name="Dependencies"></a>

PyBox has been built in the [Anaconda Python 3.6 environment](https://www.anaconda.com/download/#macos). Utilised modules included within the Anaconda environment are:

Expand Down

0 comments on commit e0271d4

Please sign in to comment.