Skip to content

Commit

Permalink
docs: add missing docstring to helper function
Browse files Browse the repository at this point in the history
  • Loading branch information
Midnighter committed May 26, 2021
1 parent f67e24b commit 60003be
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion src/memote/support/helpers.py
Original file line number Diff line number Diff line change
Expand Up @@ -641,7 +641,23 @@ def run_fba(model, rxn_id, direction="max", single_value=True):


def get_biomass_flux(model: cobra.Model, rxn_id: str) -> float:
""""""
"""
Compute the maximal objective value.
Parameters
----------
model : cobra.Model
The metabolic model under investigation.
rxn_id : string
A string containing the reaction ID of the desired FBA objective.
Returns
-------
float
The objective value which takes infeasibility and solver tolerances into
account.
"""
model.objective = model.reactions.get_by_id(rxn_id)
model.objective_direction = "max"
flux = model.slim_optimize(error_value=0.0)
Expand Down

0 comments on commit 60003be

Please sign in to comment.