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

MAINT: Move scripts to (installable) CLI #220

Merged
merged 25 commits into from
Jan 16, 2024
Merged

MAINT: Move scripts to (installable) CLI #220

merged 25 commits into from
Jan 16, 2024

Conversation

pastewka
Copy link
Collaborator

@pastewka pastewka commented Jan 14, 2024

We currently have a folder called "scripts" that contains what really are command line helper tools. It would be good to formally have those as command line tools and install them via pip.

Every command will be prefixed with matscipy_ to avoid naming collisions.

@jameskermode
Copy link
Member

I'll add the more well-used fracture scripts to this PR before we merge it.

@pastewka
Copy link
Collaborator Author

Okay thanks. Do you agree that we prefix everything with matscipy_? Could also use matscipy-. We could think about a script naming convention, e.g. everything hyphenized: matscipy-average-eam-potential or everything underscores matscipy_average_eam_potential or mixed matscipy_average-eam-potential. Any opinions @jameskermode @jotelha ?

@jameskermode
Copy link
Member

I would prefer everything hythenized for command line tools, slightly faster to type. We should be consistent, so we should replace any existing _ with - in the script names.

@pastewka
Copy link
Collaborator Author

Okay, agreed!

@pastewka
Copy link
Collaborator Author

An everything small case, no capital letters?

@jameskermode
Copy link
Member

Yes

@jotelha
Copy link
Contributor

jotelha commented Jan 15, 2024

Agreed, all hyphenized small case, e.g matscipy-poisson-nernst-planck.

@jameskermode jameskermode merged commit 570d8b1 into master Jan 16, 2024
21 checks passed
@jameskermode jameskermode deleted the 24_CLI branch January 16, 2024 10:37
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.

3 participants