Skip to content

Commit

Permalink
Edit text descriptions in the example notebooks
Browse files Browse the repository at this point in the history
  • Loading branch information
mdpiper committed Sep 20, 2024
1 parent d37b027 commit 282b4d2
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 46 deletions.
22 changes: 3 additions & 19 deletions examples/bmi-topography.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"id": "0",
"metadata": {},
"source": [
"# Get SRTM data through a BMI"
"# Get SRTM data with the Topography data component BMI"
]
},
{
Expand All @@ -14,7 +14,7 @@
"metadata": {},
"source": [
"This notebook describes how to download Shuttle Radar Topography Mission (SRTM) elevation data\n",
"using a [Basic Model Interface](https://bmi.readthedocs.io/) (BMI) through the `BmiTopography` class included in the `bmi-topography` package."
"using the [Basic Model Interface](https://bmi.readthedocs.io/) (BMI) provided in the Topography data component."
]
},
{
Expand All @@ -25,22 +25,6 @@
"## Setup"
]
},
{
"cell_type": "markdown",
"id": "3",
"metadata": {},
"source": [
"To ensure all dependencies are met, set up a conda environment using the environment file found in the root directory of this repository:\n",
"```\n",
"conda env create --file=environment.yml\n",
"```\n",
"\n",
"Then install the `bmi-topography` package:\n",
"```\n",
"make install\n",
"```"
]
},
{
"cell_type": "markdown",
"id": "4",
Expand Down Expand Up @@ -73,7 +57,7 @@
"id": "7",
"metadata": {},
"source": [
"Import the `BmiTopography` class from the newly installed `bmi-topography` package:"
"Import the `BmiTopography` class from the `bmi-topography` package:"
]
},
{
Expand Down
30 changes: 3 additions & 27 deletions examples/topography.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"id": "0",
"metadata": {},
"source": [
"# Get SRTM data with the Topography class"
"# Get SRTM data with the Topography data component"
]
},
{
Expand All @@ -14,31 +14,7 @@
"metadata": {},
"source": [
"This notebook describes how to download Shuttle Radar Topography Mission (SRTM) elevation data\n",
"using the `Topography` class included in the `bmi-topography` package."
]
},
{
"cell_type": "markdown",
"id": "2",
"metadata": {},
"source": [
"## Setup"
]
},
{
"cell_type": "markdown",
"id": "3",
"metadata": {},
"source": [
"To ensure all dependencies are met, set up a conda environment using the environment file found in the root directory of this repository:\n",
"```\n",
"conda env create --file=environment.yml\n",
"```\n",
"\n",
"Then install the `bmi-topography` package:\n",
"```\n",
"make install\n",
"```"
"with the Topography data component."
]
},
{
Expand All @@ -54,7 +30,7 @@
"id": "5",
"metadata": {},
"source": [
"Import the `Topography` class from the newly installed `bmi-topography` package:"
"Import the `Topography` class from the `bmi-topography` package:"
]
},
{
Expand Down

0 comments on commit 282b4d2

Please sign in to comment.