Skip to content

Commit

Permalink
git init
Browse files Browse the repository at this point in the history
  • Loading branch information
RY4GIT committed Mar 17, 2024
0 parents commit 1875d68
Show file tree
Hide file tree
Showing 24 changed files with 12,905 additions and 0 deletions.
82 changes: 82 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
*.pdf
*.pptx
*.bk
*.URL
*.xlsx
*.jpeg
*.jpg
*.png
*.docx
*.xlsx
*.nc
*.pyc

src/config.ini
src/cmd.txt
src/auth.json

## VS CODE
.vscode
.vscode/*
# !.vscode/settings.json
# !.vscode/tasks.json
# !.vscode/launch.json
# !.vscode/extensions.json
# *.code-workspace
# */.vscode/*

### Python ###
# Byte-compiled / optimized / DLL files
__pycache__/
*/__pycache__/
*.py[cod]
*$py.class
# **/__pycache__/* # old version

# Jupyter notebook
*-checkpoint.ipynb
.ipynb_checkpoints
*/.ipynb_checkpoints/*

# IPython
profile_default/
ipython_config.py


### macOS ###
# General
.DS_Store/
.AppleDouble
.LSOverride

# Icon must end with two \r
Icon


# Thumbnails
._*

# Files that might appear in the root of a volume
.DocumentRevisions-V100
.fseventsd
.Spotlight-V100
.TemporaryItems
.Trashes
.VolumeIcon.icns
.com.apple.timemachine.donotpresent

# Directories potentially created on remote AFP share
.AppleDB
.AppleDesktop
Network Trash Folder
Temporary Items
.apdisk

# operating system-related files
# file properties cache/storage on macOS
*.DS_Store
# thumbnail cache on Windows
Thumbs.db

#
notebooks/Interactive-1.ipynb
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2022 Ryoko Araki

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
37 changes: 37 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Interactive map: Perceptual Models Around the World by McMillan lab
Repository for **[the perceptual model interactive map](http://www.mcmillanhydrology.org/PerceptualModelDashboard.html)** :world_map:

Read our paper:
McMillan, H., Araki, R., Gnann, S., Woods, R., & Wagener, T. (n.d.). How do hydrologists perceive watersheds? A survey and analysis of perceptual model figures for experimental watersheds. Hydrological Processes. https://doi.org/10.1002/hyp.14845

![alt text](perceptual_model.PNG?raw=true)

# Links
- [The database design (ER diagram)](https://dbdiagram.io/d/63f6895b296d97641d830705)
- [The hydrologic process taxonomy used in the analysis](http://mcmillanhydrology.org/ProcessTaxonomy/ProcessTaxonomyDiagram.html)
- [Technical instruction on how this map is created](https://www.notion.so/raraki/Database-instruction-521fa8f832794cf0aade20bec576a725) (PostgreSQL + Python + Arc-GIS dashboard)

# Code
## To update database & webmap
- `0-debug_excelsheets.ipynb`
- `1-build_database.ipynb`
- `2-update_webmap.ipynb`
## To initiate the webmap
- Run `0-debug_excelsheets.ipynb` and `1-build_database.ipynb` and then run the followings:
- `init_create_webmap_private.ipynb`
- `init_create_webmap_public.ipynb`
## Other utilities
- `calc_stats.sql` holds query script to calculate statistics used in [the paper](https://doi.org/10.1002/hyp.14845)
- `utils` directory holds some codes for standalone utilities
- `debug` holds some codes for debugging database. Use when `1-build_database.ipynb` SQL codes are not working as expected

# Contact
We are looking to add more perceptual models to the interactive map and intersted in developing better design codes for drawing perceptual models in the hydrologic community!
- If you find perceptual models to be included in the map (both texts and illustrations are welcome!) or want to discuss the model
- **Hilary McMillan** (hmcmillan (at) sdsu (dot) edu)
- If you have questions about the technical details of the map
- **Ryoko Araki** (raraki8159 (at) sdsu (dot) edu)

# Acknowledgement
I appreciate [Jessica](https://github.com/jlembury), Atsushi, and Kyle for helping me with the coding!

Loading

0 comments on commit 1875d68

Please sign in to comment.