diff --git a/_toc.yml b/_toc.yml index ad80cca..a508871 100644 --- a/_toc.yml +++ b/_toc.yml @@ -4,27 +4,27 @@ - part: "Data Retrieval and Processing" chapters: - file: "sources/01 Overview.md" - - file: "sources/01a Download Process.ipynb" - - file: "sources/01b Visualization.ipynb" - - file: "sources/01c Coverage Analysis.ipynb" - - file: "sources/01d True-color Mosaic.ipynb" + - file: "sources/01a-download-process.ipynb" + - file: "sources/01b-visualization.ipynb" + - file: "sources/01c-coverage-analysis.ipynb" + - file: "sources/01d-true-color-mosaic.ipynb" - part: "Spectral Indices" chapters: - file: "sources/02 Overview.md" - - file: "sources/02a Area of Interest Definition and Product Download.ipynb" - - file: "sources/02b NDVI.ipynb" + - file: "sources/02a-area-of-interest-definition-and-product-download.ipynb" + - file: "sources/02b-ndvi.ipynb" sections: - - file: "sources/02c Corrupted Zip File.ipynb" - - file: "sources/02c Multiprocessing Benchmarks.ipynb" - - file: "sources/02d Cloud Masks.ipynb" - - file: "sources/02b Timeseries.ipynb" - - file: "sources/02e Spectral Indices.ipynb" + - file: "sources/02c-corrupted-zip-file.ipynb" + - file: "sources/02c-multiprocessing-benchmarks.ipynb" + - file: "sources/02d-cloud-masks.ipynb" + - file: "sources/02b-timeseries.ipynb" + - file: "sources/02e-spectral-indices.ipynb" - part: "Burn Ratio Calculations" chapters: - file: "sources/03 Overview.md" - - file: "sources/03a Forest Fire Product Downloads.ipynb" - - file: "sources/03b Forest Fires 2018 and 2019.ipynb" - - file: "sources/03c dNBR.ipynb" + - file: "sources/03a-forest-fire-product-downloads.ipynb" + - file: "sources/03b-forest-fires-2018-and-2019.ipynb" + - file: "sources/03c-dnbr.ipynb" - part: "Appendix" chapters: - file: "sources/XX sentinel_helpers.rst" diff --git a/rename.sh b/rename.sh new file mode 100755 index 0000000..cf49f3b --- /dev/null +++ b/rename.sh @@ -0,0 +1,12 @@ +#!/usr/bin/env bash + +OIFS="$IFS" +IFS=$'\n' +for file in `find sources -maxdepth 1 -type f -name "*.ipynb"` +do + name="$(basename $file)" + renamed="$(basename $file | sed 's/.*/\L&/' | sed 's/ /-/g')" + sed -i "s/$name/$renamed/g" sources/*.ipynb _toc.yml + git mv $file "sources/$renamed" +done +IFS="$OIFS" diff --git a/sources/01a Download Process.ipynb b/sources/01a-download-process.ipynb similarity index 99% rename from sources/01a Download Process.ipynb rename to sources/01a-download-process.ipynb index a59e255..a3ed149 100644 --- a/sources/01a Download Process.ipynb +++ b/sources/01a-download-process.ipynb @@ -542,7 +542,7 @@ "source": [ "```{note}\n", "The geometrical shape of the captured data depends on where the Sentinel-2 satellite was in orbit when it crossed the area of interest.\n", - "For an in-depth analysis see [](01c Coverage Analysis.ipynb).\n", + "For an in-depth analysis see [](01c-coverage-analysis.ipynb).\n", "```" ] }, diff --git a/sources/01b Visualization.ipynb b/sources/01b-visualization.ipynb similarity index 99% rename from sources/01b Visualization.ipynb rename to sources/01b-visualization.ipynb index 71c430a..a854e6d 100644 --- a/sources/01b Visualization.ipynb +++ b/sources/01b-visualization.ipynb @@ -561,7 +561,7 @@ "\n", "### Creating a Subset of the Area of Interest\n", "\n", - "It is rare to plot the entire product because the data in this product can be partially missing depending on the orbit position (see [](01c Coverage Analysis.ipynb) for more information).\n", + "It is rare to plot the entire product because the data in this product can be partially missing depending on the orbit position (see [](01c-coverage-analysis.ipynb) for more information).\n", "\n", "We can create a rectangular cutout of the created image using code provided in the `rasterio` library for its `rio` command line tool. The code uses a data structure called `Window`, which is a rectangle with an x- and y-offset that is provided by `rasterio` to partially read or write raster data.\n", "\n", diff --git a/sources/01c Coverage Analysis.ipynb b/sources/01c-coverage-analysis.ipynb similarity index 99% rename from sources/01c Coverage Analysis.ipynb rename to sources/01c-coverage-analysis.ipynb index 0ae2196..93a9e52 100644 --- a/sources/01c Coverage Analysis.ipynb +++ b/sources/01c-coverage-analysis.ipynb @@ -122,7 +122,7 @@ "\n", "## UTM Tile Numbers\n", "\n", - "Each tile has a distinct UTM tile reference number which is encoded in the product identifier as explained in [](01a Download Process.ipynb):" + "Each tile has a distinct UTM tile reference number which is encoded in the product identifier as explained in [](01a-download-process.ipynb):" ] }, { @@ -248,7 +248,7 @@ "## Product Shape and Orbit Number\n", "\n", "As mentioned above, each square is a single product that can be downloaded from the Copernicus Open Access Hub.\n", - "The visualizations above and the true color rendering in [](01b Visualization.ipynb) shows that these products are not often not perfect squares, but that they have missing slices.\n", + "The visualizations above and the true color rendering in [](01b-visualization.ipynb) shows that these products are not often not perfect squares, but that they have missing slices.\n", "\n", "This is because of the satellite orbit at the time of capturing the data.\n", "To visualize this we plot the available products per orbit:" @@ -601,7 +601,7 @@ "For the union above we did not consider cloud coverage at all.\n", "This means that a lot of pixels in the large area of interest might not have interesting data for us:\n", "\n", - "A plot of the cloud coverage can give us an estimate of how useful the combined image would be without needing to plot it visually as described in [](01b Visualization.ipynb):" + "A plot of the cloud coverage can give us an estimate of how useful the combined image would be without needing to plot it visually as described in [](01b-visualization.ipynb):" ] }, { diff --git a/sources/01d True-color Mosaic.ipynb b/sources/01d-true-color-mosaic.ipynb similarity index 100% rename from sources/01d True-color Mosaic.ipynb rename to sources/01d-true-color-mosaic.ipynb diff --git a/sources/02a Area of Interest Definition and Product Download.ipynb b/sources/02a-area-of-interest-definition-and-product-download.ipynb similarity index 100% rename from sources/02a Area of Interest Definition and Product Download.ipynb rename to sources/02a-area-of-interest-definition-and-product-download.ipynb diff --git a/sources/02b NDVI.ipynb b/sources/02b-ndvi.ipynb similarity index 100% rename from sources/02b NDVI.ipynb rename to sources/02b-ndvi.ipynb diff --git a/sources/02b Timeseries.ipynb b/sources/02b-timeseries.ipynb similarity index 99% rename from sources/02b Timeseries.ipynb rename to sources/02b-timeseries.ipynb index dc14585..9058a17 100644 --- a/sources/02b Timeseries.ipynb +++ b/sources/02b-timeseries.ipynb @@ -6,7 +6,7 @@ "source": [ "# Time Series\n", "\n", - "Based on the preparation done in [](02b NDVI.ipynb), this section will contain calculations of the NDVI for an entire year and compare value developments in the different subsections of the area as previously defined." + "Based on the preparation done in [](02b-ndvi.ipynb), this section will contain calculations of the NDVI for an entire year and compare value developments in the different subsections of the area as previously defined." ] }, { @@ -43,9 +43,9 @@ "source": [ "Due to an unexpected failure of the Copernicus Open Access Hub API, several of the downloaded products were unusable due to data corruption.[^data_corruption] This is considered in the processing code by excluding the corrupted files.\n", "\n", - "Additionally, even though acceptable products were restricted [](02a Area of Interest Definition and Product Download.ipynb) to only those with a low cloud coverage, in some products clouds might still obscure the particular area of interest inside the products. If less than 50% of the area of interest is visible inside a particular product, the product is deemed to not contain enough usable data and skipped as well.\n", + "Additionally, even though acceptable products were restricted [](02a-area-of-interest-definition-and-product-download.ipynb) to only those with a low cloud coverage, in some products clouds might still obscure the particular area of interest inside the products. If less than 50% of the area of interest is visible inside a particular product, the product is deemed to not contain enough usable data and skipped as well.\n", "\n", - "[^data_corruption]: See [](02c Corrupted Zip File.ipynb) for details.\n", + "[^data_corruption]: See [](02c-corrupted-zip-file.ipynb) for details.\n", "\n", "## Data Processing" ] diff --git a/sources/02c Corrupted Zip File.ipynb b/sources/02c-corrupted-zip-file.ipynb similarity index 100% rename from sources/02c Corrupted Zip File.ipynb rename to sources/02c-corrupted-zip-file.ipynb diff --git a/sources/02c Multiprocessing Benchmarks.ipynb b/sources/02c-multiprocessing-benchmarks.ipynb similarity index 98% rename from sources/02c Multiprocessing Benchmarks.ipynb rename to sources/02c-multiprocessing-benchmarks.ipynb index 9363bce..5d85738 100644 --- a/sources/02c Multiprocessing Benchmarks.ipynb +++ b/sources/02c-multiprocessing-benchmarks.ipynb @@ -6,7 +6,7 @@ "source": [ "# Multi-Processing Performance Benchmarks\n", "\n", - "This section contains a performance comparison of single- and multiprocess-based calculation methods used in [](02b Timeseries.ipynb).\n", + "This section contains a performance comparison of single- and multiprocess-based calculation methods used in [](02b-timeseries.ipynb).\n", "\n", "The `%%timeit` cell magic runs the cell content multiple times and prints statistics on those multiple runs. This reduces factors such as garbage collection pauses which influence the runtime performance and can be used to verify performance assumptions." ] diff --git a/sources/02d Cloud Masks.ipynb b/sources/02d-cloud-masks.ipynb similarity index 100% rename from sources/02d Cloud Masks.ipynb rename to sources/02d-cloud-masks.ipynb diff --git a/sources/02e Spectral Indices.ipynb b/sources/02e-spectral-indices.ipynb similarity index 100% rename from sources/02e Spectral Indices.ipynb rename to sources/02e-spectral-indices.ipynb diff --git a/sources/03a Forest Fire Product Downloads.ipynb b/sources/03a-forest-fire-product-downloads.ipynb similarity index 99% rename from sources/03a Forest Fire Product Downloads.ipynb rename to sources/03a-forest-fire-product-downloads.ipynb index fcc6989..a81136f 100644 --- a/sources/03a Forest Fire Product Downloads.ipynb +++ b/sources/03a-forest-fire-product-downloads.ipynb @@ -266,7 +266,7 @@ "metadata": {}, "source": [ "Which is a part of approximately 91% of the products for the entire year and therefore a download duration of roughly 67 hours.\n", - "This number represents a fraction of the actual processing time needed due to problems with [data corruption](02c Corrupted Zip File.ipynb) and manual verification steps." + "This number represents a fraction of the actual processing time needed due to problems with [data corruption](02c-corrupted-zip-file.ipynb) and manual verification steps." ] }, { diff --git a/sources/03b Example Initialized Downloads.ipynb b/sources/03b-example-initialized-downloads.ipynb similarity index 100% rename from sources/03b Example Initialized Downloads.ipynb rename to sources/03b-example-initialized-downloads.ipynb diff --git a/sources/03b Forest Fires 2018 and 2019.ipynb b/sources/03b-forest-fires-2018-and-2019.ipynb similarity index 100% rename from sources/03b Forest Fires 2018 and 2019.ipynb rename to sources/03b-forest-fires-2018-and-2019.ipynb diff --git a/sources/03c dNBR.ipynb b/sources/03c-dnbr.ipynb similarity index 100% rename from sources/03c dNBR.ipynb rename to sources/03c-dnbr.ipynb diff --git a/sources/XX SNAP via Python.ipynb b/sources/xx-snap-via-python.ipynb similarity index 100% rename from sources/XX SNAP via Python.ipynb rename to sources/xx-snap-via-python.ipynb