OpenFreeEnergy / OpenFreeEnergy/openfe
Provide some tutorial inputs & outputs for validation
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 332
- Forks
- 56
- Avg merge
- 5d 2h
- Merged PRs (30d)
- 13
Description
In order to help our users have confidence that they are using openfe correctly, we should provide some example inputs and outputs for our Protocols which our users can try to replicate.
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
Start by locating the Protocol documentation and any existing tutorial or example structure. Define representative inputs and expected outputs for the Protocols, then document them so users can reproduce the examples and compare their results.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100