From 35aa08b614e883e89c8fb144a85310b1df253da4 Mon Sep 17 00:00:00 2001 From: lb584 <lb584@cam.ac.uk> Date: Tue, 16 Jan 2024 12:20:15 +0000 Subject: [PATCH] doc work --- docs/_source/installation.rst | 8 ++++++++ docs/_static/assets/linux_create_dirs.sh | 14 ++++++++++++++ docs/_static/assets/windows_create_dirs.batch | 1 + docs/api.rst | 2 +- 4 files changed, 24 insertions(+), 1 deletion(-) create mode 100644 docs/_static/assets/linux_create_dirs.sh create mode 100644 docs/_static/assets/windows_create_dirs.batch diff --git a/docs/_source/installation.rst b/docs/_source/installation.rst index 5ba7340..585033c 100644 --- a/docs/_source/installation.rst +++ b/docs/_source/installation.rst @@ -41,9 +41,17 @@ In this example, we are using the Linux user “ewsmanager†and group “ews mkdir ./logs; mkdir -p ./envs/credentials +.. code-block:: bash + + mkdir -p ./code regions/EastAfrica/workspace regions/SouthAsia/workspace regions/EastAfrica/resources regions/SouthAsia/resources met_inputs/metofficeupload/upload/Ethiopia/toMO/ met_inputs/metofficeupload/upload/Ethiopia/fromMO/daily_name/ web_data/Ethiopia met_inputs/metofficeupload/upload/SouthAsia/toMO/ met_inputs/metofficeupload/upload/SouthAsia/fromMO/daily_name/ web_data/SouthAsia ./logs ./envs/credentials .. code-block:: bash + mkdir -p .\code regions\EastAfrica\workspace regions\SouthAsia\workspace regions\EastAfrica\resources regions\SouthAsia\resources met_inputs\metofficeupload\upload\Ethiopia\toMO\ met_inputs\metofficeupload\upload\Ethiopia\fromMO\daily_name\ web_data\Ethiopia met_inputs\metofficeupload\upload\SouthAsia\toMO\ met_inputs\metofficeupload\upload\SouthAsia\fromMO\daily_name\ web_data\SouthAsia .\logs .\envs\credentials + +:download:`Download .batch file <../_static/assets/windows_create_dirs.batch>` +:download:`Download .sh file <../_static/assets/linux_create_dirs.batch>` + chmod -R g+sw <install_location> (make all files written here default to the current user group, and group-writable diff --git a/docs/_static/assets/linux_create_dirs.sh b/docs/_static/assets/linux_create_dirs.sh new file mode 100644 index 0000000..fea167b --- /dev/null +++ b/docs/_static/assets/linux_create_dirs.sh @@ -0,0 +1,14 @@ +#!/bin/bash +mkdir ./code; +mkdir -p regions/EastAfrica/workspace; +mkdir -p regions/SouthAsia/workspace; +mkdir -p regions/EastAfrica/resources; +mkdir -p regions/SouthAsia/resources; +mkdir -p met_inputs/metofficeupload/upload/Ethiopia/toMO/; +mkdir -p met_inputs/metofficeupload/upload/Ethiopia/fromMO/daily_name/; +mkdir -p web_data/Ethiopia; +mkdir -p met_inputs/metofficeupload/upload/SouthAsia/toMO/; +mkdir -p met_inputs/metofficeupload/upload/SouthAsia/fromMO/daily_name/; +mkdir -p web_data/SouthAsia; +mkdir ./logs; +mkdir -p ./envs/credentials; \ No newline at end of file diff --git a/docs/_static/assets/windows_create_dirs.batch b/docs/_static/assets/windows_create_dirs.batch new file mode 100644 index 0000000..b95f12a --- /dev/null +++ b/docs/_static/assets/windows_create_dirs.batch @@ -0,0 +1 @@ +this is a batch file \ No newline at end of file diff --git a/docs/api.rst b/docs/api.rst index 92c6af1..3d57073 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -6,7 +6,7 @@ API :template: custom-module-template.rst :recursive: - coordinator +.. coordinator plotting ews_postprocessing met_processing -- GitLab