OpenFreeEnergy / OpenFreeEnergy/openfe
Add docs for accessing protocol results
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 331
- Forks
- 56
- Avg merge
- 3d 9h
- Merged PRs (30d)
- 13
Description
Following #2187 it would be great to have a cookbook which shows how to do this.
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 reading issue #2187 to understand the protocol results workflow, then find the repository's existing cookbook structure. Document how to access protocol results in a cookbook entry, with completion defined by a clear example that follows the workflow from #2187.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Needs clarification
- Newbie friendliness
- 45/100