Skip to content

Consistency between CLI and Python interfaces. #486

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

Open
oerc0122 opened this issue Mar 25, 2025 · 3 comments
Open

Consistency between CLI and Python interfaces. #486

oerc0122 opened this issue Mar 25, 2025 · 3 comments
Assignees
Labels
api API breaking changes enhancement New/improved feature or request good first issue Good for newcomers

Comments

@oerc0122
Copy link
Collaborator

Currently, there are some cases (e.g. temp_max, temp_min vs. temp_start, temp_end) where python keywords do not align with CLI. These should be made uniform.

In order to rectify this, depending on how we feel about API breaking changes at this stage, we can do the following.

If CLI name adopted in Python:

  • rename the positional argument to the new name
  • Add the alias (old) term to KW only block
  • Raise DeprecationWarning on using old kw.

If Python name adopted in CLI:

  • Add new term as option
  • Move the alias (old) term to a new argument group (c.f. Group CLI options #484) (Deprecated)
  • Raise DeprecationWarning on using old term.

If we're not that concerned (code considered beta?) we can just rename the terms as is and update the tutorials accordingly.

@oerc0122 oerc0122 added enhancement New/improved feature or request good first issue Good for newcomers labels Mar 25, 2025
@oerc0122 oerc0122 self-assigned this Mar 25, 2025
@ElliottKasoar
Copy link
Member

ElliottKasoar commented Mar 26, 2025

If we're not that concerned (code considered beta?) we can just rename the terms as is and update the tutorials accordingly.

I would still consider the code to be in beta, but given the number of people who do seem to be using it practically, it's probably worth deprecating arguments where possible, as long as it doesn't inhibit the changes we want to make.

This isn't quite the focus of the issue, but while we're at it, I also wonder if we want to change from --model-path just to --model, since in a lot of cases it's not a path to a model, but a model name etc.

This also makes it clearer that you shouldn't need to pass model names via calc-kwargs (as we still do in various places).

@alinelena
Copy link
Member

+1 for model instead of model-path.

@ElliottKasoar ElliottKasoar assigned alinelena and unassigned oerc0122 Apr 4, 2025
@ElliottKasoar ElliottKasoar added the api API breaking changes label Apr 11, 2025
@ElliottKasoar
Copy link
Member

While we're breaking things, we should consider improving the name of filter_func, as discussed in #311, which doesn't need to be tied to #313, although it's worth considering the future inclusion of constraints.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api API breaking changes enhancement New/improved feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants