From 9e5c30622cf8a191db8f835df6be6d0c1dfe9fbe Mon Sep 17 00:00:00 2001
From: lkugler <lukas.kugler@gmail.com>
Date: Thu, 18 Jan 2024 02:17:19 +0100
Subject: [PATCH] docs
---
dartwrf/prepare_wrfrundir.py | 8 ++++++--
dartwrf/wrfinput_add_geo.py | 8 ++++----
dartwrf/wrfout_add_geo.py | 2 +-
3 files changed, 11 insertions(+), 7 deletions(-)
diff --git a/dartwrf/prepare_wrfrundir.py b/dartwrf/prepare_wrfrundir.py
index 99690da..f118070 100755
--- a/dartwrf/prepare_wrfrundir.py
+++ b/dartwrf/prepare_wrfrundir.py
@@ -1,7 +1,11 @@
-"""Prepare WRF run directories, to use wrf.exe then
+"""Prepare WRF run directories, to use wrf.exe later
+Creates a directory where WRF will run (temporary);
+Creates softlinks from WRF's `run/` directory;
+Links executables set in `cluster.ideal` and `cluster.wrfexe`;
+If `exp.input_profile` is set, links the input profiles.
Args:
- init_time (str): YYYY-MM-DD_HH:MM
+ init_time (str): Initialization time in format YYYY-MM-DD_HH:MM
Returns:
None
diff --git a/dartwrf/wrfinput_add_geo.py b/dartwrf/wrfinput_add_geo.py
index aa1400c..6d9284e 100755
--- a/dartwrf/wrfinput_add_geo.py
+++ b/dartwrf/wrfinput_add_geo.py
@@ -1,8 +1,8 @@
-"""Add geogrid data to wrfinput
-this is needed for DART, but not provided by ideal.exe
+"""Add geogrid data to wrfinput.
+DART needs a georeference, but ideal.exe does not provide it
-take LAT,LON, mapfac from geogrid, so that they are consistent.
-do not change E, F, HGT_M as they would alter the dynamics and have no impact on assimilation
+Takes LAT,LON, mapfac from geogrid, so that they are consistent.
+Does not change E, F, HGT_M as they would alter the dynamics and have no impact on assimilation
example call:
./wrfinput_add_geo.py geo_em.d01.nc wrfinput_d01
diff --git a/dartwrf/wrfout_add_geo.py b/dartwrf/wrfout_add_geo.py
index 8be29aa..86c7ae8 100755
--- a/dartwrf/wrfout_add_geo.py
+++ b/dartwrf/wrfout_add_geo.py
@@ -8,7 +8,7 @@ fields_new = ["XLAT", "XLONG", "CLAT",
"XLONG_U", "XLONG_V", "XLAT_U", "XLAT_V"]
def run(geo_data_file, wrfout_file):
- """Add geogrid data to wrfinput
+ """Add geogrid data to a wrfout file
DART needs a georeference, but ideal.exe does not provide it
Takes LAT,LON, mapfac from geogrid, so that they are consistent.
--
GitLab