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.

Sign up for GitHub

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

Jump to bottom

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

Closed
Tracked by #517
ns-rse opened this issue Oct 30, 2024 · 0 comments · Fixed by #1077
Closed
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 · Fixed by #1077
Labels
documentation v2.4.0

Comments

@ns-rse
Copy link
Collaborator

ns-rse commented Oct 30, 2024 •
edited
Loading

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.
@ns-rse ns-rse mentioned this issue Oct 30, 2024
Open
13 tasks
@ns-rse ns-rse added the v2.4.0 label Jan 15, 2025
@ns-rse ns-rse mentioned this issue Jan 22, 2025
Merged
ns-rse added a commit that referenced this issue Jan 22, 2025
@ns-rse
docs: how to add functions and modules
4c4c97c 
Closes #989

As I go through writing additional entry points for #517 I thought it worth documenting how to incorporate functionality
into the workflow in terms of adding it to the end-to-end pipeline and how to create an additional entry point so that
the specific functionality can be run on its own.

This is based on having done `filters` (#741) over a few weeks and as I go forward with subsequent (e.g. #742) which I've
started I may well tweak/revise these notes in case I've missed anything or made mistakes.
@ns-rse ns-rse closed this as completed in 53b4463 Jan 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation v2.4.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: how to add functions and modules AFM-SPM/TopoStats
1 participant
@ns-rse