Skip to content

Commit

Permalink
update citation and run notebook info in readme and notebook
Browse files Browse the repository at this point in the history
  • Loading branch information
gantian127 committed Nov 6, 2024
1 parent 0a15590 commit 8dab16e
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 10 deletions.
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,26 +7,28 @@ and use the [Landlab](https://landlab.readthedocs.io/en/master/) components
to delineate the watershed and simulate the overland flow for a study area in the Boulder County.

This Jupyter Notebook is part of the work for a research paper
["CSDMS Data Components: data-model integration tools for Earth surface processes modeling"](https://doi.org/10.5194/gmd-2023-127).
["CSDMS Data Components: data-model integration tools for Earth surface processes modeling"](https://gmd.copernicus.org/articles/17/2165/2024/gmd-17-2165-2024.html).

### Notebook Citation
Gan, T., Tucker, G. E., Overeem, I. (2023). Data Component Use Case for Overland Flow Simulation, HydroShare,
https://doi.org/10.4211/hs.bcbcfe823cc4432f8ce96c3048d4591f
Gan, T., Tucker, G. E., Overeem, I. (2024). Data Component Use Case for Overland Flow Simulation, HydroShare,
https://doi.org/10.4211/hs.f94596fe50e74d93bd372125c5fab424


### Run the Notebook
You can choose the following methods to run this Jupyter Notebook:

#### Method 1: HydroShare
Please go to the [HydroShare Resource](https://www.hydroshare.org/resource/bcbcfe823cc4432f8ce96c3048d4591f/)
and follow the instruction in the **"Abstract"** section to run this notebook.
[//]: # (#### Method 1: HydroShare)

#### Method 2: CSDMS
[//]: # (Please go to the [HydroShare Resource](https://www.hydroshare.org/resource/bcbcfe823cc4432f8ce96c3048d4591f/) )

[//]: # (and follow the instruction in the **"Abstract"** section to run this notebook.)

#### Method 1: CSDMS
Please go to the [CSDMS EKT Lab](https://csdms.colorado.edu/wiki/Lab-0030)
and follow the instruction in the **"Lab notes"** section to run this notebook.


#### Method 3: Local PC
#### Method 2: Local PC
Please first download all the files from this repository and have
[conda](https://conda.io/projects/conda/en/latest/user-guide/install/index.html) installed on the local PC.
Then, use the following commands to create a virtual environment and launch the Jupyter Notebook.
Expand Down
4 changes: 2 additions & 2 deletions overland_flow.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
" <br>\n",
"\n",
"\n",
"**Suggested Citation:** Gan, T., Tucker, G. E., Overeem, I. (2023). Data Component Use Case for Overland Flow Simulation, HydroShare, https://www.hydroshare.org/resource/bcbcfe823cc4432f8ce96c3048d4591f/\n",
"**Suggested Citation:** Gan, T., Tucker, G. E., Overeem, I. (2024). Data Component Use Case for Overland Flow Simulation, HydroShare, https://www.hydroshare.org/resource/f94596fe50e74d93bd372125c5fab424/\n",
"\n",
"**Run this notebook:** Please follow the instructions [here](https://github.com/gantian127/overlandflow_usecase#data-component-use-case-for-overland-flow-simulation) to run this notebook on the local PC or the online platform.\n"
]
Expand Down Expand Up @@ -755,7 +755,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.9.16"
"version": "3.10.9"
}
},
"nbformat": 4,
Expand Down

0 comments on commit 8dab16e

Please sign in to comment.