Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
cdanielmachado committed Jan 16, 2018
1 parent d59b3fc commit 3eb3426
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 3 deletions.
44 changes: 42 additions & 2 deletions docs/advanced.rst
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,13 @@ _____________________
**CarveMe** implements a top-down reconstruction approach that requires a well-curated universal model to be used as
template for the model *carving* process.

Currently, only a bacterial template is provided. However, you are free to try to build and use your own templates.
Currently, you can choose between the universal bacterial template, or two templates specialized for gram-positive and
gram-negative bacteria:

.. code-block:: console
$ carve genome.faa -u grampos
$ carve genome.faa -u gramneg
A script with some utility functions is available to help you build your own templates. For instructions please check:

Expand All @@ -130,5 +136,39 @@ You can then provide your own customized universe model during reconstruction:

.. code-block:: console
$ carve genome.faa -u yeast_universe.xml
$ carve genome.faa --universe-file yeast_universe.xml
Experimental constraints
________________________

When you have experimental evidence for the presence/absence of a given set of reactions, you can provide this information
to improve the reconstruction process. According to the level of evidence, you can format your data as *soft* or *hard*
constraints. These can be applied to any kind of reaction present in the universe model (exchange, transport or enzymatic reactions).

**Soft constraints** are used to change the priority given to a set of reactions, as well as their expected direction.
They can be used when there is limited amount of evidence for some expected phenotype.
For instance, if the organism you are reconstructing is closely related to other organisms that are known to secrete a
given compound, you can include the respective exchange reaction as a *soft* constraint.

.. code-block:: console
$ carve genome.faa --soft data.tsv
Where *data.tsv* is a tab-separated file with two columns, the reaction identifiers and the respective values.
Each value is one of the following: 1) reaction occurs in forward direction, -1) reaction occurs in backward direction,
0) reaction does not occur.

**Hard constraints** are used to force the fluxes through a given set of reactions during reconstruction. They can be used
when there is absolute evidence about a given phenotype. For instance, if you are reconstructing an obligatory anaerobe,
you can force the oxygen uptake rate to be zero.

.. code-block:: console
$ carve genome.faa --hard data.tsv
Where *data.tsv* is a tab-separated file with three columns, reaction identifiers, lower bounds, and upper bounds.
Please use *hard* constraints with care, as they can make the reconstruction problem infeasible when incorrectly formulated.



6 changes: 5 additions & 1 deletion docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,11 @@ Additionally, you must manually install two external dependencies:

Note that you will need to register with IBM to obtain an academic license for CPLEX.

If at any point *carveme* complains about missing or outdated files, please run:
Also, after installing CPLEX, do not forget to install the CPLEX python API (see the CPLEX documentation_ for details).

.. _documentation: https://www.ibm.com/support/knowledgecenter/SSSA5P_12.7.1/ilog.odms.cplex.help/CPLEX/GettingStarted/topics/set_up/Python_setup.html

After installation you should run the initialization script to update the internal data files:

.. code-block:: console
Expand Down

0 comments on commit 3eb3426

Please sign in to comment.