Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Roodmus v0.3.0 utilities #28

Open
JatGreer opened this issue Feb 21, 2024 · 0 comments
Open

Roodmus v0.3.0 utilities #28

JatGreer opened this issue Feb 21, 2024 · 0 comments

Comments

@JatGreer
Copy link
Contributor

JatGreer commented Feb 21, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

No branches or pull requests

1 participant