Task #3014
gmxapi example Python scripts
Description
Complete functioning sample scripts serve as documentation by example. In addition to their possible "cook book" utility, they illustrate the idioms of the user interface, the scope of functionality, and use cases of note.
They should be tested.
Task: Small samples of script in documentation strings should be tested with a utility such as doctest
Task: Complete sample scripts should be viewable and tested. The scripts should be discoverable, so a home needs to be found and hyperlinks added somewhere. Sample input also needs a home, and automated testing should occur regularly (perhaps once per patch release).
Related issues
History
#1 Updated by Eric Irrgang 12 months ago
- Status changed from New to In Progress
- Target version changed from 2020 to 2021-infrastructure-stable
This is somewhat blocked by pending updates to automated infrastructure, as well as a few other tracked issues. I don't think there is anything blocking the 2020 release, though.
#2 Updated by Eric Irrgang 12 months ago
- Related to Feature #2896: Python packaging added
#3 Updated by Eric Irrgang 12 months ago
- Related to Task #2756: gmxapi integration testing added
#4 Updated by Eric Irrgang 12 months ago
- Related to Feature #2961: How should Python package find GROMACS resources under various circumstances? added
#5 Updated by Eric Irrgang 11 months ago
- Parent task deleted (
#2985)
#6 Updated by Eric Irrgang 11 months ago
- Related to Feature #3295: Expand gmxapi.modify_input use cases. added