Skip to content

Commit

Permalink
Make an examples landing page (#77)
Browse files Browse the repository at this point in the history
* Linkify the examples listing

* Edit text

* Add a landing page notebook

* Edit text descriptions in the example notebooks

* Make pretty
  • Loading branch information
mdpiper authored Sep 20, 2024
1 parent 99a847b commit 5061348
Show file tree
Hide file tree
Showing 4 changed files with 120 additions and 118 deletions.
47 changes: 47 additions & 0 deletions examples/README.ipynb
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
{
"cells": [
{
"cell_type": "markdown",
"id": "0",
"metadata": {},
"source": [
"# Examples: bmi-topography"
]
},
{
"cell_type": "markdown",
"id": "1",
"metadata": {},
"source": [
"Here are a few examples of using the Topography data component,\n",
"*bmi-topography*.\n",
"\n",
"* [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",
"* [bmi-topography_ex.sh](./bmi-topography_ex.sh): This shell script demonstrates how to call the Topography CLI.\n",
"* [bmi-topography_ex.py](./bmi-topography_ex.py): An example Python script that used in the main [README](../README.md).\n",
"* [config.yaml](./config.yaml): A configuration file used to pass parameters to the Topography BMI."
]
}
],
"metadata": {
"kernelspec": {
"display_name": "CSDMS",
"language": "python",
"name": "csdms"
},
"language_info": {
"codemirror_mode": {
"name": "ipython",
"version": 3
},
"file_extension": ".py",
"mimetype": "text/x-python",
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.11.7"
}
},
"nbformat": 4,
"nbformat_minor": 5
}
15 changes: 5 additions & 10 deletions examples/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,9 @@
# Examples
# Examples: bmi-topography

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

* `topography.ipynb` and `bmi-topography.ipynb`: These Jupyter Notebooks show
how to call the Topography data component through its API and its BMI,
respectively.
* `bmi-topography_ex.sh`: This shell script demonstrates how to call the
Topography CLI.
* `bmi-topography_ex.py`: An example Python script is used in the main
[README](../README.md).
* `config.yaml`: A configuration file used to pass parameters to the Topography
BMI.
* [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.
* [bmi-topography_ex.sh](./bmi-topography_ex.sh): This shell script demonstrates how to call the Topography CLI.
* [bmi-topography_ex.py](./bmi-topography_ex.py): An example Python script that is used in the main [README](../README.md).
* [config.yaml](./config.yaml): A configuration file used to pass parameters to the Topography BMI.
Loading

0 comments on commit 5061348

Please sign in to comment.