Skip to content

Commit

Permalink
update: readme
Browse files Browse the repository at this point in the history
  • Loading branch information
RY4GIT committed May 21, 2024
1 parent 59be967 commit 847ee55
Showing 1 changed file with 12 additions and 7 deletions.
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,28 @@
[![Perceptual Model](https://github.com/RY4GIT/perceptual-model-arcgis-public/blob/main/readme/perceptual_model.PNG)](http://www.mcmillanhydrology.org/PerceptualModelDashboard.html)
# Perceptual Model Database
This repo contains a released version of the perceptual data model database from https://doi.org/10.1002/hyp.14845.
Visualization is available as **[the perceptual model interactive map](http://www.mcmillanhydrology.org/PerceptualModelDashboard.html)** :world_map:
This repo contains a released version of the perceptual data model database from https://doi.org/10.1002/hyp.14845
Visit **[the perceptual model interactive map](http://www.mcmillanhydrology.org/PerceptualModelDashboard.html)** for the visualization:world_map:

**Perceptual model** is defined as:
> An expert summary of the watershed and its runoff processes often supported by field observations. Perceptual models are often presented as a schematic figure, although such a figure will necessarily simplify the hydrologist's complex mental model (McMillan et al., 2022)
Currently our database holds **396 models** in both text and figure format collected from hydrologic literature.

## Installation/Getting Started
1. Create your environment
Use Conda to create an environment
**1. Create your environment**
Use Conda to create an environment
```
conda env create -f environment.yml
```
Or use the `environment_minimal.yml` if it fails.

2. Building the database
To build the SQL database based on the raw data in the `data` directory, run the following code in order:
**2. Building the perceptual model database**
`src/` contains scripts to build the PostgreSQL database based on the raw data in the `data` directory.
Run the following code in order:
- `0-debug_excelsheets.ipynb`
- `1-build_database.ipynb`

### Create webmap
`src/webmap` contains example scripts that are used to create [the ArcGIS interactive webmap](http://www.mcmillanhydrology.org/PerceptualModelDashboard.html).
`src/webmap` contains example scripts that are used to create [the ArcGIS interactive webmap](http://www.mcmillanhydrology.org/PerceptualModelDashboard.html).
To initiate the webmap after building the SQL database:
- Run `init_create_webmap.ipynb` to initiate a webmap
- Or, run `update_webmap.ipynb` to update an existing webmap
Expand Down

0 comments on commit 847ee55

Please sign in to comment.