PEtab-dev / PEtab-dev/petab_sciml
Add design principles page
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 11
- Forks
- 4
- PR merge metrics
- No merged PRs in 30d
Description
To help understand the format of the spec, I think it would be great to have a page on design principles in the spec.
Overall, I consider the design principles to be:
- Adhere as close as possible to the PEtab standard. That is, we want to support all PEtab features, and for new things added, we want them to adhere as close as possible to the PEtab logic.
- Performance. This is why we make the distinction partially on static and dynamic hybridization. Because if the ML model is evaluated pre-simulation, we can make quite a number of optimizations in the code.
@dilpath anything else you think would be worthwhile to include?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate the existing specification documentation structure and its navigation entry point. Add a design-principles page covering adherence to the PEtab standard and performance, including the static/dynamic hybridization rationale; confirm the page is linked and renders with the rest of the spec.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100