SciML / ReactionNetworkImporters.jl

Julia Catalyst.jl importers for various reaction network file formats like BioNetGen and stoichiometry matrices
https://docs.sciml.ai/ReactionNetworkImporters/stable/
MIT License
26 stars 8 forks source link

Update README.md #83

Closed paulflang closed 1 year ago

paulflang commented 1 year ago

We made the experience that writing BioNetGen and importing via SBMLtk works in some cases where importing the .net file doesn't (translating the functional rate parameters). You just have to make sure you use the newest BNG version. They fixed a bug in the SBML export around Dec 2020, was in 2.5.something IIRC.

isaacsas commented 1 year ago

@paulflang I updated the readme to say:

"SBMLToolkit.jl provides an alternative for loading SBML files into Catalyst models, offering a much broader set of supported features. It allows the import of models that include features such as constant species, boundary condition species, events, constraint equations and more."

so I'm going to close this. I think that better advertises SBMLToolkit for people wanting more functionality.

paulflang commented 1 year ago

Thanks, Sam. But I think the problem with this explanation is that it is not clear what to do if a BioNetGen model cannot be imported into Julia if the import fails with ReactionNetworkImporters. This is because some (many?) people are not aware of the writeSBML() function in BioNetGen. I think it is not easily findable in the BioNetGen documentation. So perhaps the following would clarify that:

"SBMLToolkit.jl provides an alternative for loading SBML files into Catalyst models, offering a much broader set of supported features. It allows the import of models that include features such as constant species, boundary condition species, events, constraint equations and more. The BioNetGen function to export SBML is writeSBML()."

isaacsas commented 1 year ago

I'll add a comment that SBML files can be generated in many standard modeling tools (including BioNetGen). I think it makes more sense for you to have the SBMLToolkit docs explain how to generate SBML files in various tools than for us to start discussing that here.