Skip to content

Commit 5061348

Browse files
authored
Make an examples landing page (#77)
* Linkify the examples listing * Edit text * Add a landing page notebook * Edit text descriptions in the example notebooks * Make pretty
1 parent 99a847b commit 5061348

File tree

4 files changed

+120
-118
lines changed

4 files changed

+120
-118
lines changed

examples/README.ipynb

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
{
2+
"cells": [
3+
{
4+
"cell_type": "markdown",
5+
"id": "0",
6+
"metadata": {},
7+
"source": [
8+
"# Examples: bmi-topography"
9+
]
10+
},
11+
{
12+
"cell_type": "markdown",
13+
"id": "1",
14+
"metadata": {},
15+
"source": [
16+
"Here are a few examples of using the Topography data component,\n",
17+
"*bmi-topography*.\n",
18+
"\n",
19+
"* [topography.ipynb](./topography.ipynb) and [bmi-topography.ipynb](./bmi-topography.ipynb): These Jupyter Notebooks show how to call the Topography data component through its API and its BMI, respectively.\n",
20+
"* [bmi-topography_ex.sh](./bmi-topography_ex.sh): This shell script demonstrates how to call the Topography CLI.\n",
21+
"* [bmi-topography_ex.py](./bmi-topography_ex.py): An example Python script that used in the main [README](../README.md).\n",
22+
"* [config.yaml](./config.yaml): A configuration file used to pass parameters to the Topography BMI."
23+
]
24+
}
25+
],
26+
"metadata": {
27+
"kernelspec": {
28+
"display_name": "CSDMS",
29+
"language": "python",
30+
"name": "csdms"
31+
},
32+
"language_info": {
33+
"codemirror_mode": {
34+
"name": "ipython",
35+
"version": 3
36+
},
37+
"file_extension": ".py",
38+
"mimetype": "text/x-python",
39+
"name": "python",
40+
"nbconvert_exporter": "python",
41+
"pygments_lexer": "ipython3",
42+
"version": "3.11.7"
43+
}
44+
},
45+
"nbformat": 4,
46+
"nbformat_minor": 5
47+
}

examples/README.md

+5-10
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,9 @@
1-
# Examples
1+
# Examples: bmi-topography
22

33
Here are a few examples of using the Topography data component,
44
*bmi-topography*.
55

6-
* `topography.ipynb` and `bmi-topography.ipynb`: These Jupyter Notebooks show
7-
how to call the Topography data component through its API and its BMI,
8-
respectively.
9-
* `bmi-topography_ex.sh`: This shell script demonstrates how to call the
10-
Topography CLI.
11-
* `bmi-topography_ex.py`: An example Python script is used in the main
12-
[README](../README.md).
13-
* `config.yaml`: A configuration file used to pass parameters to the Topography
14-
BMI.
6+
* [topography.ipynb](./topography.ipynb) and [bmi-topography.ipynb](./bmi-topography.ipynb): These Jupyter Notebooks show how to call the Topography data component through its API and its BMI, respectively.
7+
* [bmi-topography_ex.sh](./bmi-topography_ex.sh): This shell script demonstrates how to call the Topography CLI.
8+
* [bmi-topography_ex.py](./bmi-topography_ex.py): An example Python script that is used in the main [README](../README.md).
9+
* [config.yaml](./config.yaml): A configuration file used to pass parameters to the Topography BMI.

0 commit comments

Comments
 (0)