Skip to content

Commit

Permalink
Enhance docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
Paulocracy committed Feb 1, 2021
1 parent 6bc97bd commit dbcc83f
Showing 1 changed file with 7 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,15 @@ def create_reaction_id_to_dG0_mapping_json(model: cobra.Model, json_path: str) -
lets the Equilibrator API calculate the dG0 values for each reaction using
the MetaNetX IDs for the metabolites.
This function is specifically written for the E. coli models used in CommModelPy's
publication as its selection of dG0 values is based on BiGG identifiers and as it
contains specific dG0 corrections for special reactions as referenced in the
comments of this function.
However, the general basis of this function can be easily adapted for other types of models.
Arguments:
* model: cobra.Model ~ The cobrapy model instance for which the dG0 mapping shall be created.
* json_path: str ~
* json_path: str ~ The path to the dG0 JSON that is going to be created.
Output:
* No variable but a JSON file with the mapping at json_path
Expand Down

0 comments on commit dbcc83f

Please sign in to comment.