Updates for DevCell project#314
Conversation
There was a problem hiding this comment.
Does the PURE mixture here correspond to the PURE models that Zoila built here: https://github.com/zjuradoq/PURE_CRN_models
There was a problem hiding this comment.
Not yet. The BasicPURE mixture is just EnergyTxTL with energy coming from ATP (versus 3PGA) and different parameters (in 'mixture/pure_parameters.tsv'). But I do want to add the more detailed model in as an additional mechanism.
There was a problem hiding this comment.
Should we change all parameter files to use .tsv?
There was a problem hiding this comment.
I'm not sure. Let's discuss this on #304, since if we fix things there, we can also decide on default file names. For now, I didn't do anything with the examples (partly because they are not in the actual distribution, but also because it is still valid to use .txt files).
ayush9pandey
left a comment
There was a problem hiding this comment.
The changes look good to me. Thanks for all the changes. I have added a couple of comments above.
I haven't run the notebooks individually but the tests pass so we can merge when you're ready.
This PR has a number of changes driven by work I am doing for Schmidt Sciences as part of a Developer Cell project.
Standardized keyword arguments
**kwargsand making sure that the bottom most call to various objects either checked to make sure all keyword argument were processed or didn't use them at all (in which case the system will generate an error).show_materialsinstead ofshow_material).**kwargs, which is the usual Python convention.Updated parameter file handling
Parameter files are now searched for in multiple locations:
BCP_PATHenvironment variable (separated by colons on Unix/MacOs; semicolons on Windows)The last of these allows parameters to be stored in the components/, mechanisms/, and mixtures/ directories and accessed using a path like 'mixtures/pure_parameters.tsv'.
The User Guide has also been updated to describe the changes (and move the documentation from a tutorial notebook to a RST file).
PURE mixture
Added a
BasicPUREmixture that implements the mechanisms needed to model protein expression with PURE, including energy and resource utilization. The default parameters are available in 'mixtures/pure_parameters.tsv'.Spelling corrections
Fixed the spelling of "degradation" and "Michaelis-Menten" throughout the package.
I also updated the enzyme parameters to use
enzyme,substrate, andproductinstead ofEnzyme,sub, andprod(inconsistent usage).Note that these changes will break old code since many function and parameter names have changed. Because of this, we may want to bump the minor version number (versus the patch number).
Smaller changes
pretty_printand changed some of the spacing.