From 657166d60c7a06b2c6f04b18f527c8059a337620 Mon Sep 17 00:00:00 2001 From: Philip Waggoner <31326382+pdwaggoner@users.noreply.github.com> Date: Thu, 17 Oct 2024 13:56:40 -0600 Subject: [PATCH] Update README.md --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f959cbd..a0f1082 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,9 @@ download.file(url = "https://github.com/Hammerling-Research-Group/dlq/archive/re destfile = "Desktop/DLQ.zip") # change `Desktop` to anywhere you'd like ``` -The code is separated into two main scripts: 1) `MAIN_1_simulate` runs the Gaussian puff atmospheric dispersion model, and 2) `MAIN_2_DLQ` uses output from the Gaussian puff model to perform DLQ. The `HELPER_*` scripts contain auxiliary functions used in the `MAIN_1_` and `MAIN_2_` scripts. +## Usage + +The code is separated into two main scripts: 1) `MAIN_1_simulate` runs the Gaussian puff atmospheric dispersion model, and 2) `MAIN_2_DLQ` uses output from the Gaussian puff model to perform DLQ. The `/helpers/HELPER_*` scripts contain auxiliary functions used in the `MAIN_1_` and `MAIN_2_` scripts. Inputs to the `MAIN_1_` and `MAIN_2_` files are controlled using two configuration files found in the `input_data` directory: - `simulation_config.txt` file controls input for the `MAIN_1_` script @@ -27,3 +29,5 @@ Inputs to the `MAIN_1_` and `MAIN_2_` files are controlled using two configurati The `../Example/MAIN_3_` script generates all results and figures for the accompanying manuscript (Daniels et al. 2024): https://doi.org/10.1525/elementa.2023.00110 By way of example (and to get users started with the code), `input_data` contains the raw concentration data, sensor locations, and source locations from the ADED experiment discussed in Daniels et al. 2024. + +Users should simply open and run `MAIN_1_simulate`, then `MAIN_2_DLQ`. Optional is to run the `MAIN_3_*` script.