Skip to content

Commit

Permalink
Linkify the list of examples
Browse files Browse the repository at this point in the history
  • Loading branch information
mdpiper committed Sep 20, 2024
1 parent 015a565 commit ea82f62
Showing 1 changed file with 6 additions and 8 deletions.
14 changes: 6 additions & 8 deletions examples/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
# Examples
# Examples: bmi-geotiff

Here are a few examples of using the CSDMS GeoTiff data component,
*bmi-geotiff*.

* `geotiff.ipynb` and `bmi-geotiff.ipynb`: These Jupyter Notebooks show
how to call the GeoTiff data component through its API and its BMI, respectively.
* `example-pan.py`: An example Python script showing how to load and display a panchromatic image.
* `example-rgb.py`: An example Python script showing how to load and display a three-band image.
* `example-rgb.png`: The saved output from `example-rgb.py`.
* `RGB.byte.tif`: A test GeoTIFF file [borrowed](https://github.com/rasterio/rasterio/blob/master/tests/data/RGB.byte.tif) from the [rasterio](https://github.com/rasterio/rasterio) project.
* `config.yaml`: A sample configuration file used to pass parameters to the GeoTiff data component.
* [geotiff.ipynb](./geotiff.ipynb) and [bmi-geotiff.ipynb](./bmi-geotiff.ipynb): These Jupyter Notebooks show how to call the GeoTiff data component through its API and its BMI, respectively.
* [example-pan.py](./example-pan.py): An example Python script showing how to load and display a panchromatic image.
* [example-rgb.py](./example-rgb.py): An example Python script showing how to load and display a three-band image. The saved output is in [example-rgb.png](./example-rgb.png).
* [RGB.byte.tif](./RGB.byte.tif): A test GeoTIFF file from the [rasterio](https://github.com/rasterio/rasterio) project, used under their license.
* [config.yaml](./config.yaml): A sample configuration file used to pass parameters to the GeoTiff data component.

0 comments on commit ea82f62

Please sign in to comment.