Setting out the utilities and documentation envisioned to add for Roodmus v0.3.0
The utilities which will be present follow. Each will require sphinx documentation.
conformations_sampling
run_parakeet
plot_ctf
plot_picking
plot_frames
plot_classes
plot_alignment
write_starfile
extract_particles
het_metrics
latent_clustering
het_ensemblecomparison
In addition to documentation of Roodmus CL utilities, we need to ensure completeness in the repo wrt docstrings. And ensure all utilities are covered at least by integration tests.
Should consider unit tests for critical architecture, such as utils functionality, data classes, and particularly for metadata loading/saving.
Also, update the "internal" documentation, such as how version numbering is managed, merging to develop, merging to main and associated testpypi and pypi package updates.
Setting out the utilities and documentation envisioned to add for Roodmus v0.3.0
The utilities which will be present follow. Each will require sphinx documentation.
In addition to documentation of Roodmus CL utilities, we need to ensure completeness in the repo wrt docstrings. And ensure all utilities are covered at least by integration tests.
Should consider unit tests for critical architecture, such as utils functionality, data classes, and particularly for metadata loading/saving.
Also, update the "internal" documentation, such as how version numbering is managed, merging to develop, merging to main and associated testpypi and pypi package updates.