Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
pdwaggoner authored Oct 17, 2024
1 parent f12cc29 commit 657166d
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.

0 comments on commit 657166d

Please sign in to comment.