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

Standard method to specify requirements of each workflow #2

Open
mattwthompson opened this issue Jul 16, 2019 · 0 comments
Open

Standard method to specify requirements of each workflow #2

mattwthompson opened this issue Jul 16, 2019 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@mattwthompson
Copy link
Member

There should be some standard way of documenting what each workflow needs. We don't want the user to need to install all dependencies at the top-level (including non-Python things like molecular simulation engines) to run a single workflow, so this should be done inside of each workflow. We could

  • have a separate requirements.txt in each folder
  • maybe something similar but at the high level?
  • have a block or two at the top of the notebook that checks all dependencies (including, for example gmx -h or lmp -h) and provides helpful error messages for those that aren't installed, i.e. where each might be found.
@mattwthompson mattwthompson added the documentation Improvements or additions to documentation label Jul 16, 2019
@ahy3nz ahy3nz mentioned this issue Jul 24, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant