diff --git a/examples/README.md b/examples/README.md index f2dfbc9..50df646 100644 --- a/examples/README.md +++ b/examples/README.md @@ -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.