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

Some cli renames #241

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Some cli renames #241

wants to merge 7 commits into from

Conversation

gelzinyte
Copy link
Contributor

@gelzinyte gelzinyte commented Apr 7, 2023

Mainly create new command calc which houses sub-commands for calculating properties (energy/forces/.. with gap/aca/mace, atomization energy) and descriptors (quippy). I think this is slightly more intuitive. Any objections? Any other suggestions? @bernstei @simonwengert

Also closes #193

The cli options are now

wfl 
    calculator
         ace
         atomization-energy
         gap
         mace
    descriptor
         quippy
    error
    generate
         buildcell
         smiles
    select
         cur
         lambda

wfl/cli/cli.py Outdated Show resolved Hide resolved
wfl/cli/commands/calc.py Outdated Show resolved Hide resolved
@@ -104,3 +106,22 @@ def atomization_energy(inputs, outputs, prop_prefix, prop, isolated_atom_info_ke
)


@click.command("quippy")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this already under "descriptors" somehow? If not, we should possibly move it under such a category, first because quippy also provides potentials, and 2nd, because people might want to calculate ACE descriptors some day.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah yes, this is the reason for this renaming. Currently I've merged what was in "eval" and "descriptors" into "calc", because things in both categories could be "calculated" (@gabor1 pointed out). Didn't think about quippy/ace doing both, properties and descriptors. Maybe instead should rename "eval" -> "calc-prop" & "descriptors" -> "calc-desc" or "calc-properties" & "calc-descriptors"? Just wfl descriptors would be fine, but wfl properties is maybe not as clear? Or should we just keep eval and descriptors? (It's not a big issue, but I thought I'd touch on this in the same PR"

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So this is now "calc quippy"? Can you briefly list the relevant part of the nested command tree structure that's available now (as of this PR)?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes; edited the PR description

@bernstei
Copy link
Contributor

bernstei commented Apr 7, 2023

what about moving quippy from "calc" to a new top level category "descriptors"?

@gelzinyte
Copy link
Contributor Author

I guess the only shortcoming is that descriptors are also "calculated", but if that's fine with you I'll make the change.

@bernstei
Copy link
Contributor

bernstei commented Apr 7, 2023

On slack @gabor1 suggests longer names, so how about calculators and descriptors?

@gelzinyte
Copy link
Contributor Author

Done!

@gelzinyte
Copy link
Contributor Author

Is this ok to merge? The command tree in the initial PR message is what this PR implements.

@bernstei
Copy link
Contributor

I'm generally happy with the new names. I do want to check what "atomization-energy" does, and whether it deserves to be its own subcommand. What I assumed it was doing makes more sense as an optional flag to all the other calculator choices.

@bernstei
Copy link
Contributor

OK, now I understand what it does - processes already calculated energies for isolated atoms and regular configurations and from those computes the atomization energy for each. If this is correct, @gelzinyte , I'm happy for it to be its own thing (i.e. not an optional flag to a regular calculate like I suggested above), but I'm not sure it belongs in the same top level command as ace/gap/mace, which are really doing a calculation.

@bernstei
Copy link
Contributor

@gelzinyte trying to do some cleanup. Do we remember what's the status of this one, esp. with respect to what we described in the paper?

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

Successfully merging this pull request may close these issues.

wfl eval ace fails
2 participants