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

Document how to add functionality and modules to the entry points #989

Open
Tracked by #517
ns-rse opened this issue Oct 30, 2024 · 0 comments
Open
Tracked by #517

Document how to add functionality and modules to the entry points #989

ns-rse opened this issue Oct 30, 2024 · 0 comments

Comments

@ns-rse
Copy link
Collaborator

ns-rse commented Oct 30, 2024

This should be well documented to make it easy to extend. Broadly the steps involved are...

  1. Write a new module under topostats/<module>.py
  2. Add configuration options to topostats/default_config.yaml
  3. Validate the configuration options in topostats/validation.py
  4. Add a sub-parser to topostats/entry_point.py
  5. Add a function to process (ideally in parallel) to topostats/run_modules.py

Will bulk this out as I go through the process of writing these.

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

No branches or pull requests

1 participant