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

Create Parameter documentation automatically #91

Open
anollba opened this issue Oct 18, 2024 · 1 comment
Open

Create Parameter documentation automatically #91

anollba opened this issue Oct 18, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@anollba
Copy link

anollba commented Oct 18, 2024

  • SHARC version:
  • Python version:
  • Operating System:

Description

All possible parameters are described in a .ini file in the same directory {input} as parameters.yaml file. This may be confusing, as .ini files were used before, and parameters have to be updated manually.
Ideally, parameters coukd be parsed automatically from the paremetr classes, or, even better, the classes could be derived from a parameter descriptor file, e.g., yaml. Imprtant is that they should be defined only once.

What I Did

Paste the command(s) you ran and the output.
If there was a crash, please include the traceback here.
@anollba anollba added the enhancement New feature or request label Oct 18, 2024
@brunohcfaria
Copy link

We already have a scrapper to parse ini to yaml.
Could we create something similar for parameter parsing? @RaulMyron
We could also keep a well-organized MD file with all parameters and it's descriptions, but manually maintaining it will be tedious and prone to errors...

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

No branches or pull requests

2 participants