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 6824cc0 commit 6e7693d
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,20 +26,18 @@ download.file(url = "https://github.com/Hammerling-Research-Group/dlq/archive/re

3. Go into the unzipped folder and open `DLQ.Rproj` by double clicking it. This should open a new RStudio session, with `DLQ.Rproj` set as the root.

4. In the session, navigate to the `Files` tab and start by opening and running the `MAIN_1_simulate.R` script.
4. In the session, navigate to the `Files` tab and start by opening and running the `MAIN_1_simulate.R` script. *Note*: For details on these scripts, see the `Code Structure` section below.

5. Then, proceed to and run the `MAIN_2_DLQ.R` script.

## Usage

This line only downloads the zipped main codebase. Once downloaded, it needs to be uncompressed/unzipped. This can be done manually to avoid potential errors with file paths, etc. Once unzipped, users can open DLQ.Rproj, which will initiate a new RStudio session. From there, they navigate to R, and start with MAIN_1_* , and progress through.

## Code Structure

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

- `DLQ_config.txt` controls input for the `MAIN_2_` script

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
Expand Down

0 comments on commit 6e7693d

Please sign in to comment.