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

Multi-molecule submissions via the CLI #140

Merged
merged 6 commits into from Mar 9, 2022
Merged

Multi-molecule submissions via the CLI #140

merged 6 commits into from Mar 9, 2022

Conversation

jthorton
Copy link
Contributor

@jthorton jthorton commented Mar 9, 2022

Description

This PR extends the openff-bespoke executor submit command to accept and process multiple molecules at once via multiple smiles or input file arguments. Input files may also contain multiple molecules. A formatted table is printed to the terminal and optionally written to a CSV file, which maps the input molecule to an optimization ID and input file if appropriate.

image

Status

  • Ready to go

Copy link
Contributor

@SimonBoothroyd SimonBoothroyd left a comment

Choose a reason for hiding this comment

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

Looks like a great addition 🎉! If you have a moment could you add a sentence or two to the docs (Quick Start + Executor pages maybe?) just to describe that this is now possible?

openff/bespokefit/cli/executor/submit.py Show resolved Hide resolved
openff/bespokefit/cli/executor/submit.py Show resolved Hide resolved
openff/bespokefit/cli/executor/submit.py Outdated Show resolved Hide resolved
Comment on lines +129 to +134
The `submit` command will also accept a combination of the two input forms as well as multiple occurrences of either.
After successfully submitting the molecules a table will be printed which maps the unique ID that has been assigned by
the executor to the submission to the molecule smiles and input file if appropriate. To keep track of submissions we can
also have the table saved to csv by add the corresponding `--save-submission-info` flag to the command.

The ID's can be used to check on state of the submission:
Copy link
Contributor

Choose a reason for hiding this comment

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

🎉 thanks! This should make it easier for new users to discover 😁

@codecov
Copy link

codecov bot commented Mar 9, 2022

Codecov Report

Merging #140 (ce98449) into main (09763f2) will increase coverage by 4.00%.
The diff coverage is 93.87%.

❗ Current head ce98449 differs from pull request most recent head 4db4605. Consider uploading reports for the commit 4db4605 to get more accurate results

@jthorton jthorton merged commit 6cd4703 into main Mar 9, 2022
@jthorton jthorton deleted the multi-mol-input branch March 9, 2022 15:16
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.

None yet

2 participants