diff --git a/docs/_images/ews_schematic.png b/docs/_images/ews_schematic.png new file mode 100644 index 0000000000000000000000000000000000000000..541d52fb311487640beb6dea7f5f3fcc6fd9de08 Binary files /dev/null and b/docs/_images/ews_schematic.png differ diff --git a/docs/_source/general_overview.rst b/docs/_source/general_overview.rst index 0584396787cacb6b867620cc5418014a8137d642..276441bf1cf2cbb3cb3550e071011c85898e8522 100644 --- a/docs/_source/general_overview.rst +++ b/docs/_source/general_overview.rst @@ -3,5 +3,35 @@ Overview .. _general_overview: -Was thinking high-level overview of the modulkes and how they interact/what they do. general schematics of the workflow +The EWS pipeleine is a collection of tools, coordinated via a common framework. The tools are: + +**Source calculation:** + +Calculates daily spore sources from a host map and surveillance points. Used by the MetOffice for the NAME dispersal calculations + +**Deposition:** + +Makes use of the NAME dispersal calculations provided by the UK Met Office to plot charts and show spore source locations. +**note that the Deposition tool does not currently have a separate Gitlab package**, the logic is contained within the +generic support packages: coordinator, post-processing and plotting. + +**Environmental suitability:** + +Makes use of UK Met Office weather forecasts to calculate the environmental suitability for Wheat Rust infection to occur. + +**Epidemic pressure:** + +Simulates infected area of grid cells according to epidmiological formulations and various input data streams, including +the Source calculation, Deposition and Environmental Suitability tools. + +**Advisory:** + +Assembles outputs from the other EWS tools to create word documents which can be used as templates for advisories. + +The figure below shows the various Gitlab software packages that constitute the tools listed above, and the work flows +between them. + + +.. image:: ../_images/ews_schematic.png + :alt: alternate text diff --git a/docs/_source/installation.rst b/docs/_source/installation.rst index 50253f19e8ae5e721eee5b6cd8c1db5a67ed05df..98779016115c1fb6595030d876264a46fc17397a 100644 --- a/docs/_source/installation.rst +++ b/docs/_source/installation.rst @@ -99,7 +99,7 @@ Example format: } 4: Run the docker image: ------------------------ +------------------------ install docker on your machine https://docs.docker.com/get-docker/ Build the docker image (slow, one-off step) @@ -200,6 +200,7 @@ and push to. "Survey" : { "ServerPathExtra" : "/storage/sftp/metofficeupload/upload/Ethiopia/toMO/", + **Running the pipeline** One all the necessary input data and server connections are in place, you can run the pipeline. Note that if you need to @@ -214,11 +215,11 @@ SurveyData Deposition: ^^^^^^^^^^^ -/storage/app/EWS_prod/code/coordinator/configs/docker/run/runDockerEWS.sh -p Deposition -c /storage/app/EWS_prod/regions/EastAfrica/resources/coordinator/configs/config_EastAfrica_fc_live.json -s 20220808 +/storage/app/EWS_prod/code/coordinator/configs/docker/run/runDockerEWS.sh -p Deposition -c /storage/app/EWS_prod/regions/EastAfrica/resources/coordinator/configs/config_EastAfrica_fc_live.json -s 20220808 Env suit: ^^^^^^^^^ -/storage/app/EWS_prod/code/coordinator/configs/docker/run/runDockerEWS.sh -p Environment -c /storage/app/EWS_prod/regions/EastAfrica/resources/coordinator/configs/config_EastAfrica_fc_live.json -s 20220808; +/storage/app/EWS_prod/code/coordinator/configs/docker/run/runDockerEWS.sh -p Environment -c /storage/app/EWS_prod/regions/EastAfrica/resources/coordinator/configs/config_EastAfrica_fc_live.json -s 20220808; EPI: ^^^^ @@ -229,11 +230,11 @@ Set the start of the season be editing the following lines in <install_location> Line 154 "CalculationSpanDays" : ["20220807",5], Line 225 "seasonStartString" : "20220807", -/storage/app/EWS_prod/code/coordinator/run_Processor.sh -p Epidemiology -c /storage/app/EWS_prod/regions/EastAfrica/resources/coordinator/configs/config_EastAfrica_fc_live.json -s 20220808; +/storage/app/EWS_prod/code/coordinator/run_Processor.sh -p Epidemiology -c /storage/app/EWS_prod/regions/EastAfrica/resources/coordinator/configs/config_EastAfrica_fc_live.json -s 20220808; [Currently it requires at least 2 days of output to work properly, throws an error with a single day] Advisory: -^^^^^^^^ -/storage/app/EWS_prod/code/coordinator/configs/docker/run/runDockerEWS.sh -p Advisory -c /storage/app/EWS_prod/regions/EastAfrica/resources/coordinator/configs/config_EastAfrica_fc_live.json -s 20220808; +^^^^^^^^^ +/storage/app/EWS_prod/code/coordinator/configs/docker/run/runDockerEWS.sh -p Advisory -c /storage/app/EWS_prod/regions/EastAfrica/resources/coordinator/configs/config_EastAfrica_fc_live.json -s 20220808; diff --git a/docs/_source/package_overview.rst b/docs/_source/package_overview.rst index 91e7ba012a15a421303efa2714eae0ff3852d349..1ad55015c3109f59fb632cf75014bf8648df27d9 100644 --- a/docs/_source/package_overview.rst +++ b/docs/_source/package_overview.rst @@ -14,8 +14,9 @@ Package Overview Met Processing <packages/met_processing> Environmental suitability <packages/env_suit> Epidemiology <packages/epidemiology> + Advisory <packages/advisory> -Use the links below or in the side menu to see detailsed descriptions of individual packages. +Use the links below or in the side menu to see detailed descriptions of individual packages. **General pipeline packages:** @@ -53,3 +54,12 @@ Use the links below or in the side menu to see detailsed descriptions of individ :widths: 15, 30 :ref:`Epidemiology<epidemiology_overview>`, "Simulates infected area of grid cells according to epidmiological formulations and various input data streams." + + +**Advisory builder:** + +.. csv-table:: + :header: "Package", "Description" + :widths: 15, 30 + + :ref:`Advisory builder<advisory_overview>`, "Simulates infected area of grid cells according to epidmiological formulations and various input data streams." diff --git a/docs/_source/packages/advisory.rst b/docs/_source/packages/advisory.rst new file mode 100644 index 0000000000000000000000000000000000000000..8289ca264a887b8e2dc91cfcb5f3a96bb981d6e0 --- /dev/null +++ b/docs/_source/packages/advisory.rst @@ -0,0 +1,14 @@ +.. _advisory_overview: + +Advisory builder +================ + +Overview +-------- + +Full-depth advisory docs + +APIs +---- + +:class:`Advisory` API