Deploy dev from c3b3f12

compgeolab · Apr 10, 2024 · 6f41973 · 6f41973
1 parent a5b7cc0
commit 6f41973
Show file tree

Hide file tree

Showing 248 changed files with 20,801 additions and 43,013 deletions.
diff --git a/dev/.buildinfo b/dev/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: ea071a18314af74d6cd67899df0ed9cf
+config: bdeb98ae41c1bdc55d9dc852bbf31a2e
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/dev/_images/composites_2_1.png b/dev/_images/composites_2_1.png
diff --git a/dev/_images/composites_3_0.png b/dev/_images/composites_3_0.png
diff --git a/dev/_images/composites_4_0.png b/dev/_images/composites_4_0.png
diff --git a/dev/_images/composites_5_0.png b/dev/_images/composites_5_0.png
diff --git a/dev/_images/composites_6_0.png b/dev/_images/composites_6_0.png
diff --git a/dev/_images/equalize-histogram_2_0.png b/dev/_images/equalize-histogram_2_0.png
diff --git a/dev/_images/equalize-histogram_3_0.png b/dev/_images/equalize-histogram_3_0.png
diff --git a/dev/_images/equalize-histogram_4_0.png b/dev/_images/equalize-histogram_4_0.png
diff --git a/dev/_images/index_0_0.png b/dev/_images/index_0_0.png
diff --git a/dev/_images/indices_10_0.png b/dev/_images/indices_10_0.png
diff --git a/dev/_images/indices_14_0.png b/dev/_images/indices_14_0.png
diff --git a/dev/_images/indices_1_1.png b/dev/_images/indices_1_1.png
diff --git a/dev/_images/indices_5_0.png b/dev/_images/indices_5_0.png
diff --git a/dev/_images/indices_7_0.png b/dev/_images/indices_7_0.png
diff --git a/dev/_images/indices_8_0.png b/dev/_images/indices_8_0.png
diff --git a/dev/_images/logo.svg b/dev/_images/logo.svg
diff --git a/dev/_images/missing-values_1_1.png b/dev/_images/missing-values_1_1.png
diff --git a/dev/_images/missing-values_2_0.png b/dev/_images/missing-values_2_0.png
diff --git a/dev/_images/overview_4_0.png b/dev/_images/overview_4_0.png
diff --git a/dev/_images/pansharpen_3_0.png b/dev/_images/pansharpen_3_0.png
diff --git a/dev/_images/pansharpen_5_0.png b/dev/_images/pansharpen_5_0.png
diff --git a/dev/_images/plot-overlay_1_0.png b/dev/_images/plot-overlay_1_0.png
diff --git a/dev/_images/plot-overlay_2_0.png b/dev/_images/plot-overlay_2_0.png
diff --git a/dev/_images/plot-overlay_3_0.png b/dev/_images/plot-overlay_3_0.png
diff --git a/dev/_images/plot-overlay_4_0.png b/dev/_images/plot-overlay_4_0.png
diff --git a/dev/_modules/index.html b/dev/_modules/index.html
diff --git a/dev/_modules/xlandsat/_composite.html b/dev/_modules/xlandsat/_composite.html
diff --git a/dev/_modules/xlandsat/_enhancement.html b/dev/_modules/xlandsat/_enhancement.html
diff --git a/dev/_modules/xlandsat/_interpolation.html b/dev/_modules/xlandsat/_interpolation.html
diff --git a/dev/_modules/xlandsat/_io.html b/dev/_modules/xlandsat/_io.html
diff --git a/dev/_modules/xlandsat/_pansharpen.html b/dev/_modules/xlandsat/_pansharpen.html
diff --git a/dev/_modules/xlandsat/datasets.html b/dev/_modules/xlandsat/datasets.html
diff --git a/dev/_sources/api/generated/xlandsat.adjust_l1_colors.rst b/dev/_sources/api/generated/xlandsat.adjust_l1_colors.rst
@@ -0,0 +1,10 @@
+xlandsat.adjust\_l1\_colors
+===========================
+
+.. currentmodule:: xlandsat
+
+.. autofunction:: adjust_l1_colors
+
+.. raw:: html
+
+     <div style='clear:both'></div>
diff --git a/.../api/generated/xlandsat.composite.rst.txt → ...rces/api/generated/xlandsat.composite.rst b/.../api/generated/xlandsat.composite.rst.txt → ...rces/api/generated/xlandsat.composite.rst
diff --git a/...t.datasets.fetch_brumadinho_after.rst.txt → ...ndsat.datasets.fetch_brumadinho_after.rst b/...t.datasets.fetch_brumadinho_after.rst.txt → ...ndsat.datasets.fetch_brumadinho_after.rst
diff --git a/....datasets.fetch_brumadinho_before.rst.txt → ...dsat.datasets.fetch_brumadinho_before.rst b/....datasets.fetch_brumadinho_before.rst.txt → ...dsat.datasets.fetch_brumadinho_before.rst
diff --git a/...xlandsat.datasets.fetch_liverpool.rst.txt → ...ted/xlandsat.datasets.fetch_liverpool.rst b/...xlandsat.datasets.fetch_liverpool.rst.txt → ...ted/xlandsat.datasets.fetch_liverpool.rst
diff --git a/...sets.fetch_liverpool_panchromatic.rst.txt → ...datasets.fetch_liverpool_panchromatic.rst b/...sets.fetch_liverpool_panchromatic.rst.txt → ...datasets.fetch_liverpool_panchromatic.rst
diff --git a/...ed/xlandsat.datasets.fetch_manaus.rst.txt → ...erated/xlandsat.datasets.fetch_manaus.rst b/...ed/xlandsat.datasets.fetch_manaus.rst.txt → ...erated/xlandsat.datasets.fetch_manaus.rst
diff --git a/...xlandsat.datasets.fetch_momotombo.rst.txt → ...ted/xlandsat.datasets.fetch_momotombo.rst b/...xlandsat.datasets.fetch_momotombo.rst.txt → ...ted/xlandsat.datasets.fetch_momotombo.rst
diff --git a/...d/xlandsat.datasets.fetch_roraima.rst.txt → ...rated/xlandsat.datasets.fetch_roraima.rst b/...d/xlandsat.datasets.fetch_roraima.rst.txt → ...rated/xlandsat.datasets.fetch_roraima.rst
diff --git a/...rated/xlandsat.equalize_histogram.rst.txt → ...generated/xlandsat.equalize_histogram.rst b/...rated/xlandsat.equalize_histogram.rst.txt → ...generated/xlandsat.equalize_histogram.rst
diff --git a/...ated/xlandsat.interpolate_missing.rst.txt → ...enerated/xlandsat.interpolate_missing.rst b/...ated/xlandsat.interpolate_missing.rst.txt → ...enerated/xlandsat.interpolate_missing.rst
diff --git a/...erated/xlandsat.load_panchromatic.rst.txt → .../generated/xlandsat.load_panchromatic.rst b/...erated/xlandsat.load_panchromatic.rst.txt → .../generated/xlandsat.load_panchromatic.rst
diff --git a/...api/generated/xlandsat.load_scene.rst.txt → ...ces/api/generated/xlandsat.load_scene.rst b/...api/generated/xlandsat.load_scene.rst.txt → ...ces/api/generated/xlandsat.load_scene.rst
diff --git a/...api/generated/xlandsat.pansharpen.rst.txt → ...ces/api/generated/xlandsat.pansharpen.rst b/...api/generated/xlandsat.pansharpen.rst.txt → ...ces/api/generated/xlandsat.pansharpen.rst
diff --git a/...api/generated/xlandsat.save_scene.rst.txt → ...ces/api/generated/xlandsat.save_scene.rst b/...api/generated/xlandsat.save_scene.rst.txt → ...ces/api/generated/xlandsat.save_scene.rst
diff --git a/dev/_sources/api/index.rst.txt → dev/_sources/api/index.rst b/dev/_sources/api/index.rst.txt → dev/_sources/api/index.rst
@@ -26,6 +26,7 @@ Processing
     composite
     pansharpen
     equalize_histogram
+    adjust_l1_colors
     interpolate_missing
 
 Sample datasets

diff --git a/dev/_sources/changes.rst.txt → dev/_sources/changes.rst b/dev/_sources/changes.rst.txt → dev/_sources/changes.rst
@@ -3,6 +3,42 @@
 Changelog
 =========
 
+Version 0.5.0
+-------------
+
+Released on: 2024/04/10
+
+doi: https://doi.org/10.5281/zenodo.10953496
+
+Bug fixes:
+
+* Fix issue with radiance conversion of Level 1 thermal bands (`#73 <https://github.com/compgeolab/xlandsat/pull/73>`__)
+* Add missing Cirrus and Thermal 2 bands to IO functions (`#63 <https://github.com/compgeolab/xlandsat/pull/63>`__)
+
+New features:
+
+* Add function ``adjust_l1_colors`` to fix the colors of an RGB composite made from Level 1 data (`#76 <https://github.com/compgeolab/xlandsat/pull/76>`__)
+* Add an option to download Level 1 data from the Momotombo eruption (`#75 <https://github.com/compgeolab/xlandsat/pull/75>`__)
+* Add an Level 1 scene for Momotombo (`#74 <https://github.com/compgeolab/xlandsat/pull/74>`__)
+* Allow choosing the dtype of composites (`#64 <https://github.com/compgeolab/xlandsat/pull/64>`__)
+
+Documentation:
+
+* Small improvements to some tutorials (`#77 <https://github.com/compgeolab/xlandsat/pull/77>`__)
+* Update the version of Sphinx and its plugins (`#65 <https://github.com/compgeolab/xlandsat/pull/65>`__)
+
+Maintenance:
+
+* Extend testing and support for Python 3.12 (`#80 <https://github.com/compgeolab/xlandsat/pull/80>`__)
+* Switch to pyproject.toml for package configuration (`#78 <https://github.com/compgeolab/xlandsat/pull/78>`__)
+* Use PyPI Trusted Publishers instead of API tokens (`#67 <https://github.com/compgeolab/xlandsat/pull/67>`__)
+* Use dependabot to manage GitHub Actions upgrades (`#66 <https://github.com/compgeolab/xlandsat/pull/66>`__)
+* Add social media card images (`#62 <https://github.com/compgeolab/xlandsat/pull/62>`__)
+
+This release contains contributions from:
+
+* Leonardo Uieda
+
 Version 0.4.0
 -------------
 

diff --git a/dev/_sources/citing.rst.txt → dev/_sources/citing.rst b/dev/_sources/citing.rst.txt → dev/_sources/citing.rst
diff --git a/dev/_sources/compatibility.rst.txt → dev/_sources/compatibility.rst b/dev/_sources/compatibility.rst.txt → dev/_sources/compatibility.rst
diff --git a/dev/_sources/composites.rst.txt → dev/_sources/composites.rst b/dev/_sources/composites.rst.txt → dev/_sources/composites.rst
diff --git a/dev/_sources/equalize-histogram.rst.txt → dev/_sources/equalize-histogram.rst b/dev/_sources/equalize-histogram.rst.txt → dev/_sources/equalize-histogram.rst
@@ -69,12 +69,14 @@ equalization in :func:`xlandsat.equalize_histogram`.
 .. tip::
 
     It can be helpful to do a bit of contrast stretching first, but to a lesser
-    degree than we did previously.
+    degree than we did previously. It's also a good idea to use "float32" for
+    the composite to give it a larger range of color values (but this requires
+    more RAM).
 
 .. jupyter-execute::
 
-    rgb = xls.composite(scene, rescale_to=(0, 0.6))
-    rgb_eq = xls.equalize_histogram(rgb, clip_limit=0.02, kernel_size=300)
+    rgb = xls.composite(scene, rescale_to=(0, 0.8), dtype="float32")
+    rgb_eq = xls.equalize_histogram(rgb, clip_limit=0.04, kernel_size=300)
 
     fig, ax = plt.subplots(1, 1, figsize=(10, 6))
     rgb_eq.plot.imshow(ax=ax)

diff --git a/dev/_sources/index.rst.txt → dev/_sources/index.rst b/dev/_sources/index.rst.txt → dev/_sources/index.rst
@@ -6,7 +6,7 @@
     :padding: 0 0 0 0
 
     .. grid-item::
-        :columns: 12 12 12 12
+        :columns: 12 8 8 8
 
         .. raw:: html
 
@@ -16,6 +16,13 @@
 
             Analyze Landsat remote sensing images using xarray
 
+    .. grid-item::
+        :columns: 12 4 4 4
+
+        .. image:: ./_static/logo.svg
+            :width: 200px
+            :class: sd-m-auto dark-light
+
 
 **xlandsat** is Python library for loading and analyzing Landsat scenes
 downloaded from `USGS EarthExplorer <https://earthexplorer.usgs.gov/>`__ with

diff --git a/dev/_sources/indices.rst.txt → dev/_sources/indices.rst b/dev/_sources/indices.rst.txt → dev/_sources/indices.rst
diff --git a/dev/_sources/install.rst.txt → dev/_sources/install.rst b/dev/_sources/install.rst.txt → dev/_sources/install.rst
diff --git a/dev/_sources/io.rst.txt → dev/_sources/io.rst b/dev/_sources/io.rst.txt → dev/_sources/io.rst
diff --git a/dev/_sources/missing-values.rst.txt → dev/_sources/missing-values.rst b/dev/_sources/missing-values.rst.txt → dev/_sources/missing-values.rst
@@ -1,7 +1,7 @@
 .. _missing-values:
 
-Filling missing values
-======================
+Fill missing values
+===================
 
 Landsat Level 2 data can sometimes contain missing values, particularly around
 bright clouds with dark shadows. These pixels will have a value of
@@ -11,7 +11,8 @@ can use the values of neighboring pixels to interpolate the missing values with
 
 Let's use our sample scene of the December 2015 eruption of `Momotombo volcano
 <https://en.wikipedia.org/wiki/Momotombo>`__, Nicaragua, to demonstrate how
-it's done.
+it's done. The Level 2 version of this scene has several holes because of the
+clouds and smoke from the volcano affecting the atmospheric correction method.
 
 First, we'll import the required packages and load the sample scene:
 
@@ -32,7 +33,7 @@ the missing values don't simply show up as white:
 .. jupyter-execute::
 
     # Make the composite and add it to the scene
-    rgb = xls.composite(scene, rescale_to=(0.04, 0.17))
+    rgb = xls.composite(scene, rescale_to=(0, 0.2))
 
     fig, ax = plt.subplots(1, 1, figsize=(10, 6))
 
@@ -49,7 +50,7 @@ We can fill these values with reasonable estimates using interpolation:
 
     scene_filled = xls.interpolate_missing(scene)
 
-    rgb_filled = xls.composite(scene_filled, rescale_to=(0.04, 0.17))
+    rgb_filled = xls.composite(scene_filled, rescale_to=(0, 0.2))
 
     fig, ax = plt.subplots(1, 1, figsize=(10, 6))
 

diff --git a/dev/_sources/overview.rst.txt → dev/_sources/overview.rst b/dev/_sources/overview.rst.txt → dev/_sources/overview.rst
diff --git a/dev/_sources/pansharpen.rst.txt → dev/_sources/pansharpen.rst b/dev/_sources/pansharpen.rst.txt → dev/_sources/pansharpen.rst
diff --git a/dev/_sources/plot-overlay.rst.txt → dev/_sources/plot-overlay.rst b/dev/_sources/plot-overlay.rst.txt → dev/_sources/plot-overlay.rst
@@ -11,7 +11,7 @@ volcano <https://en.wikipedia.org/wiki/Momotombo>`__, Nicaragua.
 We'll overlay the thermal band (only pixels above 320 K) on top of an RGB
 composite to show the ongoing lava flow.
 
-First, we'll import the required packages and load the sample scene:
+First, we'll import the required packages:
 
 .. jupyter-execute::
 
@@ -20,10 +20,18 @@ First, we'll import the required packages and load the sample scene:
     import xarray as xr
     import numpy as np
 
-    path = xls.datasets.fetch_momotombo()
-    scene = xls.load_scene(path)
-    # Fill the missing values due to the volcanic clouds to make it look nicer
-    scene = xls.interpolate_missing(scene)
+Now we can load a Level 1 version of the scene to make the RGB plot (the L2
+scene has a lot of issues from the atmospheric correction) and a Level 2
+version to get the thermal band as surface temperature:
+
+.. jupyter-execute::
+
+    path_l1 = xls.datasets.fetch_momotombo(level=1)
+    scene = xls.load_scene(path_l1)
+
+    path_l2 = xls.datasets.fetch_momotombo(level=2)
+    scene = scene.merge(xls.load_scene(path_l2, bands=["thermal"]))
+
     scene
 
 Now we can plot an RGB composite and thermal band separately to see that they
@@ -32,10 +40,9 @@ have to show:
 .. jupyter-execute::
 
     # Make the composite
-    rgb = xls.composite(scene, rescale_to=(0, 0.6))
-
-    # Histogram equalization for a better looking image
-    rgb = xls.equalize_histogram(rgb, clip_limit=0.02, kernel_size=200)
+    rgb = xls.composite(scene, rescale_to=(0, 0.15))
+    # Adjust the L1 colors to make it nicer and get rid of the blue glare
+    rgb = xls.adjust_l1_colors(rgb)
 
     # Plot the RGB and thermal separately
     fig, (ax1, ax2) = plt.subplots(2, 1, figsize=(10, 12))

diff --git a/dev/_sources/references.rst.txt → dev/_sources/references.rst b/dev/_sources/references.rst.txt → dev/_sources/references.rst
diff --git a/dev/_sources/versions.rst.txt → dev/_sources/versions.rst b/dev/_sources/versions.rst.txt → dev/_sources/versions.rst
@@ -7,6 +7,7 @@ Use the links below to access documentation for specific versions
 * `Latest release <http://www.compgeolab.org/xlandsat/latest>`__
 * `Development <http://www.compgeolab.org/xlandsat/dev>`__
   (reflects the current development branch on GitHub)
+* `v0.5.0 <http://www.compgeolab.org/xlandsat/v0.5.0>`__
 * `v0.4.0 <http://www.compgeolab.org/xlandsat/v0.4.0>`__
 * `v0.3.0 <http://www.compgeolab.org/xlandsat/v0.3.0>`__
 * `v0.2.0 <http://www.compgeolab.org/xlandsat/v0.2.0>`__

diff --git a/....b7bb847fb20b106c3d81b95245e65545.min.css → ....1e8bd061cd6da7fc9cf755528e8ffc24.min.css b/....b7bb847fb20b106c3d81b95245e65545.min.css → ....1e8bd061cd6da7fc9cf755528e8ffc24.min.css
diff --git a/dev/_static/basic.css b/dev/_static/basic.css
@@ -4,7 +4,7 @@
  *
  * Sphinx stylesheet -- basic theme.
  *
- * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */
@@ -222,7 +222,7 @@ table.modindextable td {
 /* -- general body styles --------------------------------------------------- */
 
 div.body {
-    min-width: 450px;
+    min-width: 360px;
     max-width: 800px;
 }
 
@@ -237,14 +237,8 @@ a.headerlink {
     visibility: hidden;
 }
 
-a.brackets:before,
-span.brackets > a:before{
-    content: "[";
-}
-
-a.brackets:after,
-span.brackets > a:after {
-    content: "]";
+a:visited {
+    color: #551A8B;
 }
 
 h1:hover > a.headerlink,
@@ -335,12 +329,16 @@ p.sidebar-title {
     font-weight: bold;
 }
 
+nav.contents,
+aside.topic,
 div.admonition, div.topic, blockquote {
     clear: left;
 }
 
 /* -- topics ---------------------------------------------------------------- */
 
+nav.contents,
+aside.topic,
 div.topic {
     border: 1px solid #ccc;
     padding: 7px;
@@ -379,13 +377,17 @@ div.body p.centered {
 
 div.sidebar > :last-child,
 aside.sidebar > :last-child,
+nav.contents > :last-child,
+aside.topic > :last-child,
 div.topic > :last-child,
 div.admonition > :last-child {
     margin-bottom: 0;
 }
 
 div.sidebar::after,
 aside.sidebar::after,
+nav.contents::after,
+aside.topic::after,
 div.topic::after,
 div.admonition::after,
 blockquote::after {
@@ -428,10 +430,6 @@ table.docutils td, table.docutils th {
     border-bottom: 1px solid #aaa;
 }
 
-table.footnote td, table.footnote th {
-    border: 0 !important;
-}
-
 th {
     text-align: left;
     padding-right: 5px;
@@ -615,19 +613,26 @@ ul.simple p {
     margin-bottom: 0;
 }
 
-dl.footnote > dt,
-dl.citation > dt {
+aside.footnote > span,
+div.citation > span {
     float: left;
-    margin-right: 0.5em;
 }
-
-dl.footnote > dd,
-dl.citation > dd {
+aside.footnote > span:last-of-type,
+div.citation > span:last-of-type {
+  padding-right: 0.5em;
+}
+aside.footnote > p {
+  margin-left: 2em;
+}
+div.citation > p {
+  margin-left: 4em;
+}
+aside.footnote > p:last-of-type,
+div.citation > p:last-of-type {
     margin-bottom: 0em;
 }
-
-dl.footnote > dd:after,
-dl.citation > dd:after {
+aside.footnote > p:last-of-type:after,
+div.citation > p:last-of-type:after {
     content: "";
     clear: both;
 }
@@ -644,10 +649,6 @@ dl.field-list > dt {
     padding-right: 5px;
 }
 
-dl.field-list > dt:after {
-    content: ":";
-}
-
 dl.field-list > dd {
     padding-left: 0.5em;
     margin-top: 0em;
@@ -673,6 +674,16 @@ dd {
     margin-left: 30px;
 }
 
+.sig dd {
+    margin-top: 0px;
+    margin-bottom: 0px;
+}
+
+.sig dl {
+    margin-top: 0px;
+    margin-bottom: 0px;
+}
+
 dl > dd:last-child,
 dl > dd:last-child > :last-child {
     margin-bottom: 0;
@@ -741,6 +752,14 @@ abbr, acronym {
     cursor: help;
 }
 
+.translated {
+    background-color: rgba(207, 255, 207, 0.2)
+}
+
+.untranslated {
+    background-color: rgba(255, 207, 207, 0.2)
+}
+
 /* -- code displays --------------------------------------------------------- */
 
 pre {

diff --git a/....b7bb847fb20b106c3d81b95245e65545.min.css → ....1e8bd061cd6da7fc9cf755528e8ffc24.min.css b/....b7bb847fb20b106c3d81b95245e65545.min.css → ....1e8bd061cd6da7fc9cf755528e8ffc24.min.css