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

Initial Jobs scripts #8

Merged
merged 2 commits into from
Sep 4, 2024
Merged

Initial Jobs scripts #8

merged 2 commits into from
Sep 4, 2024

Conversation

soge8904
Copy link
Collaborator

@soge8904 soge8904 commented Sep 3, 2024

Jobs.py uses Custodian's Job class and should be stored there when ready. It takes a .in file and runs the jdftx calculation using a command (Docker command is used atm) and outputs an out file and any requested output. Example and testing are in sample-move-later folder.

Summary

Include a summary of major changes in bullet points:

  • Feature 1
  • Fix 1

Additional dependencies introduced (if any)

  • List all new dependencies needed and justify why. While adding dependencies that bring
    significantly useful functionality is perfectly fine, adding ones that add trivial
    functionality, e.g., to use one single easily implementable function, is frowned upon.
    Justify why that dependency is needed. Especially frowned upon are circular dependencies.

TODO (if any)

If this is a work-in-progress, write something about what else needs to be done.

  • Feature 1 supports A, but not B.

Checklist

Work-in-progress pull requests are encouraged, but please put [WIP] in the pull request
title.

Before a pull request can be merged, the following items must be checked:

  • Code is in the standard Python style.
    The easiest way to handle this is to run the following in the correct sequence on
    your local machine. Start with running ruff and ruff format on your new code. This will
    automatically reformat your code to PEP8 conventions and fix many linting issues.
  • Doc strings have been added in the Numpy docstring format.
    Run ruff on your code.
  • Type annotations are highly encouraged. Run mypy to
    type check your code.
  • Tests have been added for any new functionality or bug fixes.
  • All linting and tests pass.

Note that the CI system will run all the above checks. But it will be much more
efficient if you already fix most errors prior to submitting the PR. It is highly
recommended that you use the pre-commit hook provided in the repository. Simply run
pre-commit install and a check will be run prior to allowing commits.

soge8904 and others added 2 commits September 3, 2024 16:19
…ady. It takes a .in file and runs the jdftx calculation using a command (Docker command is used atm) and outputs an out file and any requested output. Example and testing are in sample-move-later folder.
@cote3804
Copy link
Owner

cote3804 commented Sep 4, 2024

Want ability to run JDFTx with command line call to installed version eventually

@cote3804 cote3804 merged commit 5928fa7 into main Sep 4, 2024
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.

2 participants