From 4d8a4fa2a3ea5294e173cd8a4f27c307ab2e45f0 Mon Sep 17 00:00:00 2001
From: lkugler <lukas.kugler@gmail.com>
Date: Tue, 22 Jun 2021 11:32:52 +0200
Subject: [PATCH] Update README.md
---
README.md | 18 +++++++-----------
1 file changed, 7 insertions(+), 11 deletions(-)
diff --git a/README.md b/README.md
index 9e0b3b4..fa86ba5 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
# DART-WRF
-This code runs an Ensemble Data Assimilation system with the software packages DART and WRF. All workflow steps are submitted to the cluster manager SLURM, which takes care of the dependencies.
+This code runs an Ensemble Data Assimilation system with the software packages DART and WRF. All workflow steps are submitted to the cluster manager SLURM, which takes care of the dependencies (the order in which tasks are done).
- Why should I use it?
- It's pythonic: see what it does at first glance, modular, flexible
@@ -11,8 +11,9 @@ Functions return a SLURM ID which can be used to trigger the start of another fu
- Yes, but you need to [convert your observations into DART format.](https://dart.ucar.edu/pages/Observations.html#obs_real)
### A possible workflow:
-`scheduler.py`
+[`scheduler.py`](https://github.com/lkugler/DART-WRF/blob/master/scheduler.py)
```python
+### define your functions gen_synth_obs, assimilate, run_ENS, ...
# create initial conditions
id = prep_osse()
@@ -69,9 +70,11 @@ $ squeue -u `whoami` --sort=i
308393_[1-5] mem_0384 EnsWRF-3 lkugler PD 0:00 1 (Dependency)
```
-### Easily switch between clusters
+### Configure your experiment
+Define simulation specific variables in [`config/cfg.py`](https://github.com/lkugler/DART-WRF/blob/master/config/cfg.py).
-`config/clusters.py `
+### Easily switch between clusters
+Define cluster specific variables in `config/clusters.py `:
```python
clusterA = ClusterConfig()
@@ -83,13 +86,6 @@ clusterB.name = 'jet'
clusterB.userdir = '/home/pathB/myuser/'
```
-`config/cfg.py`
-```python
-
-from . import clusters
-cluster = clusters.clusterA # change cluster configuration here
-```
-
### References
This workflow was created following the [DART-WRF Tutorial](http://www.image.ucar.edu/wrfdart/tutorial/).
--
GitLab