CLI tutorial (markdown) #50
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This adds a basic CLI tutorial. The goal is to walk the user through the process of setting up, running, and gathering results using the CLI. Audience is people for whom this is their first experience with OpenFE, and they're not super into Python. They already know the science, however, and may know some of the tools in this space (LOMAP, etc).
|
|
Member
Author
|
I ran through the setup stage, but can't run the actual simulations (and therefore also can't gather the results). Could somebody else (@IAlibay ? @richardjgowers ? @RiesBen ?) run through this? |
Contributor
|
@dwhswenson can this get formatted into a notebook? Currently within binder the markdown isn't rendered. |
Member
Author
|
ufff, I guess? Do you want the commands to all be runnable then? I was kind of trying to avoid that, because running a ton of simulations (or calling sbatch where it doesn't exist) kinda sucks. |
Member
Author
|
@richardjgowers : Try again. |
Contributor
|
@dwhswenson yeah ok this is better |
richardjgowers
approved these changes
Apr 18, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds a basic CLI tutorial. The goal is to walk the user through the process of setting up, running, and gathering results using the CLI.
Audience is people for whom this is their first experience with OpenFE, and they're not super into Python. They already know the science, however, and may know some of the tools in this space (LOMAP, etc).