Commit e11dad2d authored by Carina Lansing's avatar Carina Lansing
Browse files

Updated main README file per feedback from Tami.

parent b5fad8f1
......@@ -22,29 +22,45 @@ $ cd run-lasso-o_shcu
See the appropriate README file for setup instructions for your respective
environment:
* [README-SHIFTER.md](./README-SHIFTER.md). Use these instructions if you are running at NERSC.
* [README-SHIFTER.md](./README-SHIFTER.md). Use these instructions if you are running at NERSC or have Shifter installed on your HPC cluster.
* [README-DOCKER.md](./README-DOCKER.md). Use these instructions if you are running from your local desktop. **NOTE: this should be used for small test runs only**
* [README-SINGULARITY.md](./README-SINGULARITY.md). Use these instructions if you are running from another HPC cluster.
* [README-SINGULARITY.md](./README-SINGULARITY.md). Use these instructions if you have Singularity installed on your HPC cluster.
#### 3) Prepare Simulation Data
Copy your wrf simulation(s) output to the `data/inputs folder`. You may copy over 1 - 10 different
simulation outputs. Each simulation output should be placed in two separate folders, one for wrfout files and
one for wrfstat files. The wrfout and wrfstat folders for each simulation should be named accordingly:
Place or symbolically link your WRF LES simulation wrfstat and wrfout files into the `data/inputs` directory.
You may add 1 - 10 different simulation outputs to the inputs folder. Wrfout
and wrfstat files should each be placed in a separate directory named with the correct simulation number,
as shown in the below example:
```bash
$ ls -l data/inputs
# Simulation 1
sgpwrfout1C1.00/
sgpwrfstat1C1.00/
# Simulation 2
sgpwrfout3C1.00
sgpwrfstat3C1.00
# ....
# Simulation 10
sgpwrfout10C1.00
sgpwrfstat10C1.00
$ ls data/inputs/*
data/inputs/sgpwrfout3C1.00:
wrfout_d01_2018-07-10_12:00:00.nc wrfout_d01_2018-07-10_20:00:00.nc
wrfout_d01_2018-07-10_13:00:00.nc wrfout_d01_2018-07-10_21:00:00.nc
wrfout_d01_2018-07-10_14:00:00.nc wrfout_d01_2018-07-10_22:00:00.nc
wrfout_d01_2018-07-10_15:00:00.nc wrfout_d01_2018-07-10_23:00:00.nc
wrfout_d01_2018-07-10_16:00:00.nc wrfout_d01_2018-07-11_00:00:00.nc
wrfout_d01_2018-07-10_17:00:00.nc wrfout_d01_2018-07-11_01:00:00.nc
wrfout_d01_2018-07-10_18:00:00.nc wrfout_d01_2018-07-11_02:00:00.nc
wrfout_d01_2018-07-10_19:00:00.nc wrfout_d01_2018-07-11_03:00:00.nc
data/inputs/sgpwrfout4C1.00:
wrfout_d01_2018-07-10_12:00:00.nc wrfout_d01_2018-07-10_20:00:00.nc
wrfout_d01_2018-07-10_13:00:00.nc wrfout_d01_2018-07-10_21:00:00.nc
wrfout_d01_2018-07-10_14:00:00.nc wrfout_d01_2018-07-10_22:00:00.nc
wrfout_d01_2018-07-10_15:00:00.nc wrfout_d01_2018-07-10_23:00:00.nc
wrfout_d01_2018-07-10_16:00:00.nc wrfout_d01_2018-07-11_00:00:00.nc
wrfout_d01_2018-07-10_17:00:00.nc wrfout_d01_2018-07-11_01:00:00.nc
wrfout_d01_2018-07-10_18:00:00.nc wrfout_d01_2018-07-11_02:00:00.nc
wrfout_d01_2018-07-10_19:00:00.nc wrfout_d01_2018-07-11_03:00:00.nc
data/inputs/sgpwrfstat3C1.00:
wrfstat_d01_2018-07-10_12:00:00.nc
data/inputs/sgpwrfstat4C1.00:
wrfstat_d01_2018-07-10_12:00:00.nc
```
<div style="background-color: #F9F5D2; border: 1px solid grey; margin: 10px; padding: 10px;">
......@@ -56,8 +72,8 @@ as this data is embedded in the container image.
### 4) Edit config.yml file
Edit the config.yml file to provide parameters about your run. The config.yml file contains
detailed descriptions for each parameter. If you run following these instructions, you
should be able to use the default parameters with the exception of `begin_datetime`.
This must be set to correspond to the begin time for your wrf simulation, as shown below:
should be able to use the default parameters with the exception of `begin_datetime` and
`container_runtime`, which should be modified for your specific environment, as shown below:
``` yaml
#-----------------------------------------------------------------
......@@ -70,6 +86,18 @@ This must be set to correspond to the begin time for your wrf simulation, as sho
# file.
#-----------------------------------------------------------------
begin_datetime: 20180710.115900
#-----------------------------------------------------------------
# Container Runtime
#
# Identify whether to run via Docker or Singularity. Use 'docker'
# for Docker and 'singularity' for singularity
#
# (Note, Docker is intended for small-scale runs only.)
#-----------------------------------------------------------------
#container_runtime: docker
#container_runtime: shifter
container_runtime: singularity
```
### 5) Run LASSO-O
......@@ -78,10 +106,15 @@ Start LASSO-O via the `run.sh` script from the run-lasso-o_shcu folder.
See the appropriate README file for setup instructions for your respective
environment:
* [README-SHIFTER.md](./README-SHIFTER.md). Use these instructions if you are running at NERSC.
* [README-SHIFTER.md](./README-SHIFTER.md). Use these instructions if you are running at NERSC or have Shifter installed on your HPC cluster.
* [README-DOCKER.md](./README-DOCKER.md). Use these instructions if you are running from your local desktop. **NOTE: this should be used for small test runs only**
* [README-SINGULARITY.md](./README-SINGULARITY.md). Use these instructions if you are running from another HPC cluster.
* [README-SINGULARITY.md](./README-SINGULARITY.md). Use these instructions if you have Singularity installed on your HPC cluster.
<div style="background-color: #F9F5D2; border: 1px solid grey; margin: 10px; padding: 10px;">
<strong>NOTE: </strong>
The specific run command will vary depending upon the container runtime and scheduler
used at your HPC cluster.
</div>
### 6) Plotting output and skill scores via Jupyter Notebook
See the [notebooks/README.md](notebooks/README.md) file for instructions on how to start
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment