Skip to content

Add summary info#485

Merged
ElliottKasoar merged 8 commits intoddmms:mainfrom
ElliottKasoar:add-info
Apr 21, 2026
Merged

Add summary info#485
ElliottKasoar merged 8 commits intoddmms:mainfrom
ElliottKasoar:add-info

Conversation

@ElliottKasoar
Copy link
Copy Markdown
Collaborator

Pre-review checklist for PR author

PR author must check the checkboxes below when creating the PR.

Summary

Adds summary information for calculations, analysis, and applications.

Since, for example, we can have a data-only test with no calculation, each of these is collected separately.

Categories are presented as a set of case-insensitive choices, enabling autocomplete when using the CLI. We could do the same for tests, but this would make the help incredibly long.

I have also added a new info command, with a set of sub-commands to list the available categories and tests (including tests in a specific category), and the current models too.

We may want to extend this to the available data for download, but that means further work, as currently these are hidden by default.

Linked issue

Resolves #137

Testing

Tested commands locally.

@ElliottKasoar ElliottKasoar added documentation Improvements or additions to documentation enhancement New feature or request labels Apr 20, 2026
Comment thread docs/source/developer_guide/cli.rst Outdated
@ElliottKasoar
Copy link
Copy Markdown
Collaborator Author

I may actually change it to ml_peg list calcs/analysis/app/models, which maybe sounds a bit more natural (and fits the dir names)

@ElliottKasoar ElliottKasoar merged commit 6b87fae into ddmms:main Apr 21, 2026
7 checks passed
@ElliottKasoar ElliottKasoar deleted the add-info branch April 21, 2026 12:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add CLI list option

2 participants