Skip to content

Commit

Permalink
add slides for the tutorial
Browse files Browse the repository at this point in the history
  • Loading branch information
levuvietphong committed Nov 11, 2024
1 parent ed7c00c commit f62004d
Show file tree
Hide file tree
Showing 65 changed files with 10,870 additions and 79 deletions.
8 changes: 7 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,10 @@ observations.csv

1-hydrology/results/
2-transport/results/
3-submesh/results/
3-submesh/results/

slides/slides*bk*.Rmd
slides/imgs/R/
package*
notebooks/.ipynb_checkpoints/
node_modules/
File renamed without changes.
File renamed without changes.
28 changes: 15 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# Amanzi-ATS Transport Tutorial

This hands-on tutorial offers a hands-on experience in setting up and running transport simulations based on hydrology models in [Amanzi-ATS](https://github.com/amanzi/ats). This is part of the [IDEAS-Watershed](https://ideas-watersheds.github.io/) all-hands meeting 2024 in Denver, CO.
This tutorial offers a hands-on experience in setting up and running transport simulations based on hydrology models in [Amanzi-ATS](https://github.com/amanzi/ats). This is part of the [IDEAS-Watershed](https://ideas-watersheds.github.io/) all-hands meeting 2024 in Denver, CO.

**Instructors:** Phong Le, Ethan Coon, Daniil Svyatsky

---

### 1. Learning Objectives :dart:
By the end of this workshop, participants will be able to:
* Understand key concepts of the [transport](https://github.com/amanzi/ats/tree/master/src/pk_transport) process kernel (PK) in Amanzi-ATS;
* Develop workflows that integrate transport PK into [hydrology](https://amanzi.github.io/ats/stable/input_spec/process_kernels/physical/flow.html) PK.
* Understand key concepts of the [transport process kernel (PK)](https://github.com/amanzi/ats/tree/master/src/pk_transport) in Amanzi-ATS;
* Develop workflows that couple transport PK with [hydrology PK](https://amanzi.github.io/ats/stable/input_spec/process_kernels/physical/flow.html).

---

Expand All @@ -20,8 +20,10 @@ To get the most out of this tutorial, participants should have:

---
### 3. Setup Instructions :wrench:
The tutorial will be conducted in a Docker container. The docker includes the `terminal`, `text editor`, `ats`, `python`, `jupyter notebook`, and other dependencies. The `text editor` is customized to better work with the `ats` input files in `xml` format. Follow the steps below to set up the environment.
1. **Pull the Docker Image:**
The slides for the tutorial can be found [here](./slides/slides.html).

The tutorial will be conducted in a `docker` container. The container includes the `terminal`, `text editor`, `ats`, `python`, `jupyter notebook`, and other dependencies. The `text editor` is customized to better work with the `ats` input files in `xml` format. Follow the steps below to set up the environment.
1. **Pull the `docker` image:**
Make sure to pull the Docker container for this tutorial:
```bash
docker pull --platform linux/amd64 metsi/ideas-watersheds-all-hands-2024:v0
Expand All @@ -48,11 +50,11 @@ git clone https://github.com/amanzi/ats-hands-on-transport.git
---

### 4. Workshop Outline :memo:
1. **Introduction to ATS Hydrology and Transport:**
*Overview of fundamental equations in hydrology and transport in Amanzi-ATS*

2. **Hands-On Session: Building Transport Simulations:**
*Step-by-step guidance on developing transport simulations in ATS based on the integrated hydrology model*

3. **Discussion and Feedback:**
*Open session for questions, insights, and feedback*
* **Introduction to Hydrology and Transport PKs in ATS:**
- Overview of governing equations
* **Hands-On Session: Building Transport Simulations:**
- Step-by-step guidance on developing transport simulations in ATS based on the integrated hydrology model*

* **Discussion and Feedback:**
- Open session for questions, insights, and feedback*
57 changes: 42 additions & 15 deletions notebooks/1-hydrology.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@
{
"cell_type": "code",
"execution_count": 1,
"metadata": {},
"metadata": {
"editable": true,
"tags": []
},
"outputs": [],
"source": [
"import sys\n",
Expand All @@ -25,25 +28,34 @@
},
{
"cell_type": "markdown",
"metadata": {},
"metadata": {
"editable": true,
"slideshow": {
"slide_type": "slide"
},
"tags": []
},
"source": [
"## Visualize exodus2 mesh"
]
},
{
"cell_type": "code",
"execution_count": 2,
"metadata": {},
"metadata": {
"editable": true,
"tags": []
},
"outputs": [
{
"data": {
"application/vnd.jupyter.widget-view+json": {
"model_id": "efb5afc79b7e44268273f426db3a0c07",
"model_id": "aae8240f242243cd92194c64c13a17b5",
"version_major": 2,
"version_minor": 0
},
"text/plain": [
"Widget(value='<iframe src=\"http://localhost:59416/index.html?ui=P_0x300398c20_0&reconnect=auto\" class=\"pyvista…"
"Widget(value='<iframe src=\"http://localhost:59178/index.html?ui=P_0x16524d6a0_0&reconnect=auto\" class=\"pyvista…"
]
},
"metadata": {},
Expand All @@ -52,8 +64,8 @@
],
"source": [
"domain_mesh = atsvis.load_mesh_exodus('../data/synthetic_catchment.exo', z_scale=20)\n",
"atsvis.plot_mesh(domain_mesh, show_scalar_bar=True, set_background=False,\n",
" show_toplayer=True, window_size=[800, 600])"
"pl = atsvis.plot_mesh(domain_mesh, show_scalar_bar=True, set_background=False, \n",
" clim=[8, 11], show_toplayer=True, window_size=[960, 420])"
]
},
{
Expand All @@ -66,7 +78,10 @@
{
"cell_type": "code",
"execution_count": 3,
"metadata": {},
"metadata": {
"editable": true,
"tags": []
},
"outputs": [],
"source": [
"# Load mesh polygons and data\n",
Expand All @@ -80,7 +95,10 @@
{
"cell_type": "code",
"execution_count": 4,
"metadata": {},
"metadata": {
"editable": true,
"tags": []
},
"outputs": [
{
"name": "stdout",
Expand Down Expand Up @@ -122,12 +140,15 @@
{
"cell_type": "code",
"execution_count": 5,
"metadata": {},
"metadata": {
"editable": true,
"tags": []
},
"outputs": [
{
"data": {
"application/vnd.jupyter.widget-view+json": {
"model_id": "dcc9daaa4ba442c5acc3d98946ae0866",
"model_id": "066e6b69832a42c0a8384cbad1a402be",
"version_major": 2,
"version_minor": 0
},
Expand Down Expand Up @@ -178,7 +199,7 @@
{
"data": {
"application/vnd.jupyter.widget-view+json": {
"model_id": "3551c51a43bc4ca188fbd9421a913047",
"model_id": "9fffdaa5a41f469ab7b457f4cda21638",
"version_major": 2,
"version_minor": 0
},
Expand Down Expand Up @@ -269,7 +290,13 @@
{
"cell_type": "code",
"execution_count": 9,
"metadata": {},
"metadata": {
"editable": true,
"slideshow": {
"slide_type": ""
},
"tags": []
},
"outputs": [
{
"data": {
Expand Down Expand Up @@ -307,7 +334,7 @@
],
"metadata": {
"kernelspec": {
"display_name": "pyvista",
"display_name": "Python 3 (ipykernel)",
"language": "python",
"name": "python3"
},
Expand All @@ -325,5 +352,5 @@
}
},
"nbformat": 4,
"nbformat_minor": 2
"nbformat_minor": 4
}
Loading

0 comments on commit f62004d

Please sign in to comment.