From 8be99956e588f574ee020992308b95f93178d5b9 Mon Sep 17 00:00:00 2001
From: Ignacio Pisso <Ignacio.Pisso@nilu.no>
Date: Fri, 17 Aug 2018 16:20:47 +0200
Subject: [PATCH] add README file

---
 README | 73 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 73 insertions(+)
 create mode 100644 README

diff --git a/README b/README
new file mode 100644
index 0000000..9b7dd84
--- /dev/null
+++ b/README
@@ -0,0 +1,73 @@
+flex gen cases
+
+Generates flexpart run cases based on the current default options dir and pathnames file.
+(pathanmes can be edited at a later stage to accomodate different winds with the same options IMPLEMENT
+)
+files 
+- define_<runs>: Generates flexpart run cases (groups depending on _<runs>) 
+- export*: copy define* to a ifferent directory to build the run cases there.
+- (pathanmes could be edited here)
+- loop_on_pathnames*.sh: for a fived options-pathnames pair, create a run case (adding an executable and an output directory)
+- run_all_sl*: execute the run cases generating a set of flexpart outputs
+- read_joblist*.sh: verify that the runs finished properly.
+
+input:
+ options dir: 
+   default located repo in the same directory 
+   i.e. ../flexpart/options/
+ pathname: ../flexpart/pathnames
+ destinantion dir: 
+  default "../flex_cases" alongside in the same directory level
+  it is created every time. it it already exists from a previous run it will stop 
+  (add --force option ENHANCE)
+
+history
+repo flex_gen_input cloned to ~/repos
+
+how to run
+example
+
+./export_flexgen_0.sh
+
+generates ../flex_cases 
+
+containing 
+
+Makefile
+define_default_run_0.sh*
+loop_on_pathnames_laptop.sh*
+run_all_sl_laptop*
+
+this by itself or a s a copy can generate a list of flexpart run cases
+(only default FIXME)
+
+just running 
+make or
+define_default_run_0.sh
+
+generates: 
+pathnames 
+output
+options
+
+./loop_on_pathnames_laptop.sh*
+generates a file (e.g. batch_dry_pathnames*.sl) that associates the executable with that patnames in a FLEXPART_run_string
+(the executable is by default FLEXPART_8d70e43)
+in can be configured with exporting variable $FLEXPARTvar
+
+now all batch_dry_pathnames*.sl
+can be run by
+
+./run_all_sl_*
+
+the stdout of flexpart is tee'd to stdoutbatch_dry_pathnames*.sl
+
+the output* directory(es) is(are) ready to be read by flex_read
+
+
+
+
+
+
+
+
-- 
GitLab