Skip to content

Commit 83c2cc6

Browse files
authored
Add README to tutorial (#71)
This gives a rough guided tour of how the tutorial is intended to be used; basically allowing someone to replay the tutorial as given at the OMSF workshop.
1 parent c618f87 commit 83c2cc6

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

rbfe_tutorial/README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# OpenFE RBFE Tutorial
2+
3+
This tutorial is a recommended starting place for working with OpenFE. This
4+
tutorial consists of 2 stages: first, there is the command line tutorial, where
5+
you will work with the OpenFE command line interface (CLI) to set up a
6+
simulation campaign, see how to run each simulation with the CLI, and then
7+
gather results from a previously-run simulation into a final table. The second
8+
stage uses a Jupyter notebook to perform the exact same setup as the CLI, but
9+
shows how you have more flexibility when working with the Python interface.
10+
11+
## Step-by-step
12+
13+
1. To get an overview of OpenFE, you can view [the slides](https://docs.google.com/presentation/d/12xIu7V-izt-j5nlsPD9IOXih1qm4fPPVwVdulipjSv4/) that were given with
14+
this tutorial at the OMSF workshop in May 2023.
15+
16+
2. If you haven't already, install OpenFE using [our recommended install
17+
instructions](https://docs.openfree.energy/en/stable/installation.html#installation-with-mambaforge-recommended).
18+
We highly recommend installing with `mamba` over `conda`; there is a huge
19+
gap in performance.
20+
21+
3. Follow the [CLI tutorial](cli_tutorial.md), which includes downloading the
22+
tutorial materials with the `openfe fetch` command.
23+
24+
4. Follow the notebook tutorial, running with `jupyter notebook
25+
python_tutorial.ipynb`. The notebook tutorial reproduces the setup stage of
26+
the CLI tutorial, but illustrates how you can customize things using the
27+
Python API that cannot be customized using the CLI.

0 commit comments

Comments
 (0)