Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Renamed _files directory to _media and mass-renamed filepaths #401

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes
2 changes: 1 addition & 1 deletion docs/_templates/card-clickable-list-v1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

.. container:: image-container

.. image:: {{ card.image or "/_files/default/dea-earth-thumbnail.jpg" }}
.. image:: {{ card.image or "/_media/default/dea-earth-thumbnail.jpg" }}
:class: no-gallery

.. rubric:: {{ card.name }}
Expand Down
2 changes: 1 addition & 1 deletion docs/_templates/card-description-list-v1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

.. container:: image-container

.. image:: {{ card.image or "/_files/default/dea-earth-thumbnail.jpg" }}
.. image:: {{ card.image or "/_media/default/dea-earth-thumbnail.jpg" }}
:class: no-gallery

.. rubric:: {{ card.name }}
Expand Down
2 changes: 1 addition & 1 deletion docs/_templates/external-data-v1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@

.. container::

.. image:: {{ Data.header_image or "/_files/default/dea-earth-thumbnail.jpg" }}
.. image:: {{ Data.header_image or "/_media/default/dea-earth-thumbnail.jpg" }}
:class: no-gallery

.. container::
Expand Down
10 changes: 5 additions & 5 deletions docs/_templates/home-v1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@

.. container::

.. image:: /_files/default/dea-earth-thumbnail.jpg
.. image:: /_media/default/dea-earth-thumbnail.jpg
:class: no-gallery

.. container:: showcase-panel bg-gradient-forest reverse
Expand All @@ -59,7 +59,7 @@

.. container::

.. image:: /_files/cmi/Kakadu-Mary_TCW-percentiles-wide_1.jpg
.. image:: /_media/cmi/Kakadu-Mary_TCW-percentiles-wide_1.jpg
:class: no-gallery

.. container:: showcase-panel bg-gradient-stone
Expand All @@ -75,7 +75,7 @@

.. container::

.. image:: /_files/validation/validation-drone-thumbnail.jpg
.. image:: /_media/validation/validation-drone-thumbnail.jpg
:class: no-gallery

.. container:: showcase-panel bg-gradient-space reverse
Expand All @@ -91,7 +91,7 @@

.. container::

.. image:: /_files/reference/Reporting_dashboard.png
.. image:: /_media/reference/Reporting_dashboard.png
:class: no-gallery

.. container:: showcase-panel
Expand All @@ -111,5 +111,5 @@

.. container::

.. image:: /_files/themes/sea-ocean-and-coast.*
.. image:: /_media/themes/sea-ocean-and-coast.*
:class: no-gallery
2 changes: 1 addition & 1 deletion docs/_templates/product-v1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@

.. container::

.. image:: {{ data.header_image or "/_files/default/dea-earth-thumbnail.jpg" }}
.. image:: {{ data.header_image or "/_media/default/dea-earth-thumbnail.jpg" }}
:class: no-gallery

.. container::
Expand Down
2 changes: 1 addition & 1 deletion docs/_templates/product-v2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@

.. container::

.. image:: {{ page.data.header_image or "/_files/default/dea-earth-thumbnail.jpg" }}
.. image:: {{ page.data.header_image or "/_media/default/dea-earth-thumbnail.jpg" }}
:class: no-gallery
{% endset %}

Expand Down
2 changes: 1 addition & 1 deletion docs/_templates/report-list-v1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@

.. container::

.. image:: {{ report.image or "/_files/default/dea-earth-thumbnail.jpg" }}
.. image:: {{ report.image or "/_media/default/dea-earth-thumbnail.jpg" }}
:class: no-gallery
:target: {{ report.link }}
{% endfor %}
6 changes: 3 additions & 3 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
copyright = f"{current_year}, Geoscience Australia"
author = "Geoscience Australia"

html_static_path = ["_static", "_files"]
html_static_path = ["_static", "_media"]
templates_path = ["_layouts", "_templates"]
html_extra_path = ["robots.txt"]
source_suffix = [".rst", ".md"]
Expand Down Expand Up @@ -51,7 +51,7 @@
exclude_patterns += utilities.optional_exclude_pattern("LOCAL_ENABLE_TECH_ALERTS_CHANGELOG", "tech-alerts-changelog")

html_title = "DEA Knowledge Hub"
html_logo = "_files/logos/ga-dea-combined-logo.svg"
html_logo = "_media/logos/ga-dea-combined-logo.svg"
html_favicon = "_static/favicons/dea-favicon.ico"
html_theme = 'pydata_sphinx_theme'
language = "en"
Expand Down Expand Up @@ -101,7 +101,7 @@
sitemap_url_scheme = "{link}"

ogp_site_url = "https://knowledge.dea.ga.gov.au/"
ogp_image = "/_files/logos/dea-logo-inline.png"
ogp_image = "/_media/logos/dea-logo-inline.png"

sys.path.insert(0, os.path.abspath("./notebooks/Tools"))
autosummary_generate = ["./notebooks/Tools/index.rst"]
Expand Down
12 changes: 6 additions & 6 deletions docs/data/_data.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,19 @@ description: Find metadata on our data products.
cards:
- name: Baseline satellite data
link: /data/theme/baseline-satellite-data/
image: /_files/themes/baseline-satellite-data.*
image: /_media/themes/baseline-satellite-data.*
- name: Land and vegetation
link: /data/theme/land-and-vegetation/
image: /_files/themes/land-and-vegetation.*
image: /_media/themes/land-and-vegetation.*
- name: Inland water
link: /data/theme/inland-water/
image: /_files/themes/inland-water.*
image: /_media/themes/inland-water.*
- name: Sea, ocean, and coast
link: /data/theme/sea-ocean-and-coast/
image: /_files/themes/sea-ocean-and-coast.*
image: /_media/themes/sea-ocean-and-coast.*
- name: Hazards
link: /data/theme/hazards/
image: /_files/themes/hazards.*
image: /_media/themes/hazards.*
- name: External data
link: /data/theme/external-data/
image: /_files/themes/external-data.*
image: /_media/themes/external-data.*
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

title: DEA Wetlands Insight Tool (QLD)
long_title: Wetlands Insight Tool Queensland Wetlands Polygons
header_image: /_files/cmi/PlaceholderWIT.PNG
header_image: /_media/cmi/PlaceholderWIT.PNG
version: 2.0.0
is_latest_version: true
latest_version_link: null
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ When the time series cloud and cloud shadow detection procedure completed. The d

In this step, pixels in the time series with BA>0.45 is labelled as cloud (with mask value = 3), while BA<=-0.0999 is labelled as invalid (with mask value = 1). The procedure is shown in Figure 1.

:::{figure} /_files/dea-cloud-and-cloud-shadow-mask/cloud_1.png
:::{figure} /_media/dea-cloud-and-cloud-shadow-mask/cloud_1.png
:alt: identify extreme data

Figure 1. Identify extreme and invalid data.
Expand All @@ -121,7 +121,7 @@ Figure 1. Identify extreme and invalid data.

The updated time series is shown in Figure 2.

:::{figure} /_files/dea-cloud-and-cloud-shadow-mask/cloud_2.png
:::{figure} /_media/dea-cloud-and-cloud-shadow-mask/cloud_2.png
:alt: Updated time series with extreme and invalid pixels removed

Figure 2. Updated time series with extreme and invalid pixels removed
Expand All @@ -131,7 +131,7 @@ Figure 2. Updated time series with extreme and invalid pixels removed

This is done by applying local time series noise filter on the whole time series, the time series with identified cloud and cloud shadow pixels is shown in Figure 3.

:::{figure} /_files/dea-cloud-and-cloud-shadow-mask/cloud_3.png
:::{figure} /_media/dea-cloud-and-cloud-shadow-mask/cloud_3.png
:alt: Time series with cloud and cloud shadow pixels identified

Figure 3. Time series with cloud and cloud shadow pixels identified
Expand All @@ -141,7 +141,7 @@ Figure 3. Time series with cloud and cloud shadow pixels identified

In the current implementation, the local time series noise filter was applied 3 times with N=1, 2 times with N=2 and 1 time with N=3, where 3N is the length of the local time series noise filter. The filtered time series after Step 4 is shown in Figure 4.

:::{figure} /_files/dea-cloud-and-cloud-shadow-mask/cloud_4.png
:::{figure} /_media/dea-cloud-and-cloud-shadow-mask/cloud_4.png
:alt: Time series with cloud and cloud shadow pixels removed

Figure 4. Time series with cloud and cloud shadow pixels removed
Expand All @@ -151,7 +151,7 @@ Figure 4. Time series with cloud and cloud shadow pixels removed

Detect ground objects which are wrongly classified as clouds and cloud shadows. Output the identified cloud and cloud shadow pixels as a cloud and cloud shadow mask, as shown in Figure 5.

:::{figure} /_files/dea-cloud-and-cloud-shadow-mask/cloud_5.png
:::{figure} /_media/dea-cloud-and-cloud-shadow-mask/cloud_5.png
:alt: The output of cloud and cloud shadow mask for the time series

Figure 5. The output of cloud and cloud shadow mask for the time series
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

A Sentinel-2 true colour image and a **cloud mask** created by the cloud and cloud shadow mask algorithm

![true colour cloud image p1](/_files/dea-cloud-and-cloud-shadow-mask/cloud_org_1.PNG) ![cloud mask image p1](/_files/dea-cloud-and-cloud-shadow-mask/cloud_mask_1.PNG)
![true colour cloud image p1](/_media/dea-cloud-and-cloud-shadow-mask/cloud_org_1.PNG) ![cloud mask image p1](/_media/dea-cloud-and-cloud-shadow-mask/cloud_mask_1.PNG)

A Sentinel-2 true colour image and a **cloud shadow mask** created by the cloud and cloud shadow mask algorithm

![true colour image shadow 1](/_files/dea-cloud-and-cloud-shadow-mask/shadow_org_1.PNG)![cloud shadow mask p1](/_files/dea-cloud-and-cloud-shadow-mask/shadow_mask_1.PNG)
![true colour image shadow 1](/_media/dea-cloud-and-cloud-shadow-mask/shadow_org_1.PNG)![cloud shadow mask p1](/_media/dea-cloud-and-cloud-shadow-mask/shadow_mask_1.PNG)

Some of the earlier multi-granule Sentinel-2 L1C products may contain incorrect Military Grid Reference System (MGRS) granule ID when comparing against product extent metadata. No TSmask product will be generated for such granule that contains incorrect metadata.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

title: DEA Intertidal Suite (Draft - Product Testing only)
long_title: National Intertidal Product Suite v1.0.0
header_image: /_files/cmi/nidem 2 - crop 3_1.jpg
header_image: /_media/cmi/nidem 2 - crop 3_1.jpg
version: 1.0.0
is_latest_version: true
latest_version_link: null
Expand Down
2 changes: 1 addition & 1 deletion docs/data/archive/draft-dea-waterbodies-landsat/_data.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

title: DRAFT DEA Waterbodies (Landsat)
long_title: Geoscience Australia Landsat Waterbodies Collection 3
header_image: /_files/cmi/waterbodies.jpg
header_image: /_media/cmi/waterbodies.jpg
version: 3.0.0
is_latest_version: true
latest_version_link: null
Expand Down
2 changes: 1 addition & 1 deletion docs/data/external-data/abares-clum-2020/_data.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

title: ABARES CLUM 2020
long_title: ABARES Catchment Scale Land Use of Australia - Update December 2020
header_image: /_files/external-data/abares_clum_2020.thumbnail.jpg
header_image: /_media/external-data/abares_clum_2020.thumbnail.jpg
product_type: null
spatial_data_type: Raster
time_span:
Expand Down
2 changes: 1 addition & 1 deletion docs/data/external-data/abares-clum-2023/_data.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

title: ABARES CLUM 2023
long_title: ABARES Catchment Scale Land Use of Australia - Update December 2023
header_image: /_files/external-data/abares_clum_2023.thumbnail.jpg
header_image: /_media/external-data/abares_clum_2023.thumbnail.jpg
product_type: null
spatial_data_type: Raster
time_span:
Expand Down
2 changes: 1 addition & 1 deletion docs/data/external-data/ga-ausbathytopo-250m/_data.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

title: GA AusBathyTopo 250m Grid
long_title: Geoscience Australia AusBathyTopo 250m (Australia) 2023 Grid
header_image: /_files/external-data/ga_ausbathytopo250m_2023.thumbnail.jpg
header_image: /_media/external-data/ga_ausbathytopo250m_2023.thumbnail.jpg
product_type: null
spatial_data_type: Raster
time_span:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

title: GA Multi-scale Topographic Position
long_title: Geoscience Australia Multi-scale Topographic Position Image of Australia
header_image: /_files/external-data/ga_mtpi_thumbnail.jpg
header_image: /_media/external-data/ga_mtpi_thumbnail.jpg
product_type: null
spatial_data_type: Raster
time_span:
Expand Down
2 changes: 1 addition & 1 deletion docs/data/external-data/ga-srtm-1-second-dem/_data.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

title: GA SRTM 1 second DEM
long_title: Geoscience Australia Shuttle Radar Topography Mission 1 second DEM version 1.0
header_image: /_files/external-data/ga_srtm_thumbnail.jpg
header_image: /_media/external-data/ga_srtm_thumbnail.jpg
product_type: null
spatial_data_type: Raster
time_span:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

short_name: Australian Geographic Reference Image
full_technical_name: null
header_image: /_files/cmi/agri.jpg
header_image: /_media/cmi/agri.jpg

version_number: 1.0.0
is_latest_version: true
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Changes may be made at any time, without prior notice, to these Terms. Should ne
3) Run the application. Launch the Specchio client from your install directory or command line, it is called "specchio-client.jar".
4) Get started with the NSD: Select "Database" from the top left-hand corner of the client, then "Create a user account". See below:

![connection_tab](/_files/cmi/connection.jpg)
![connection_tab](/_media/cmi/connection.jpg)

To access the service enter the following information:

Expand All @@ -83,19 +83,19 @@ The NSD contains datasets or campaigns of data that can be viewed in two ways.

1) View the NSD folder structure via the data browser:

![data_browser](/_files/cmi/data_browser.jpg)
![data_browser](/_media/cmi/data_browser.jpg)

![data_browser_2](/_files/cmi/data_browser2.jpg)
![data_browser_2](/_media/cmi/data_browser2.jpg)

Expand folders to the desired level, then view (show report), plot spectra, and export data. You may also manually subset data from folders by selecting multiple individual files, shown above. The report applies to the selected spectra: either at the folder or individual file level.

2) Query the NSD for specific metadata parameters:

![query_builder](/_files/cmi/query_1.jpg)
![query_builder](/_media/cmi/query_1.jpg)

Select the metadata category you wish to filter by on the left-hand side. For example, to retrieve all entries for NSW, select the Location category on the left, then add "NSW" to the "State/Territory" field and hit Run Query on the right:

![query_2](/_files/cmi/query_2.jpg)
![query_2](/_media/cmi/query_2.jpg)

As in the Data Browser, spectra found from the Query Builder can be viewed and exported in the same way.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

short_name: Australian National Spectral Database
full_technical_name: null
header_image: /_files/cmi/spectral_2.jpg
header_image: /_media/cmi/spectral_2.jpg

version_number: 3.3.0
is_latest_version: true
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ With the path pointing to the 1.8 JRE.

Note 2: Data within the NSD are stored hierarchically so data should be exported by selecting the folder above the desired data. If you do not download data from its root folder, you will lose folder sub-structure labels. See below for an example:

:::{figure} /_files/cmi/NSD_known_issues.png
:::{figure} /_media/cmi/NSD_known_issues.png
:alt: NSD browser screen grab
:::

Expand Down
2 changes: 1 addition & 1 deletion docs/data/product/daily-satpaths-beta/_data.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

short_name: Daily SatPaths
full_technical_name: Daily Satellite Paths predictor
header_image: /_files/cmi/SatPaths_image.png
header_image: /_media/cmi/SatPaths_image.png

version_number: 1.0.3-beta
is_latest_version: true
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

short_name: DEA Burnt Area Characteristic Layers Sentinel-2 Near Real-Time
full_technical_name: Geoscience Australia Burnt Area Characteristic Layers Sentinel-2 Near Real-Time
header_image: /_files/cmi/ga_s2_ba_provisional_3_interim_thumbnail.jpg
header_image: /_media/cmi/ga_s2_ba_provisional_3_interim_thumbnail.jpg

version_number: 1.0.0
is_latest_version: true
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ $$

The delta NBR layer displays values between -1 and +1, with positive value being more indicative that an area has been burnt, colour bar provided below.

![colourbar ranging from -1 to +1](/_files/dea-burnt-area/legend_dnbr.png)
![colourbar ranging from -1 to +1](/_media/dea-burnt-area/legend_dnbr.png)

### Delta Bare Soil Index ($\Delta$BSI)

Expand All @@ -78,7 +78,7 @@ $$

Delta BSI is multiplied by negative 1 in order to reverse the scaling so that it can be presented the same way as the other delta indexes, which all have positive values for areas that shows characteristics of being burnt. The $\Delta$BSI layer displays values between -1 and +1, with a positive value being more indicative that an area has increased exposure of bare soil. Colour bar provided, below.

![Colourbar for dBSI product between -1 to +1](/_files/dea-burnt-area/legend_dbsi.png)
![Colourbar for dBSI product between -1 to +1](/_media/dea-burnt-area/legend_dbsi.png)

### Delta Normalised Difference Vegetation Index ($\Delta$NDVI)

Expand All @@ -98,7 +98,7 @@ $$

The $\Delta$NDVI layer displays values between -1 and +1, with positive values being more indicative that green vegetation in an area has decreased, and therefore showing the characteristics of being burnt.

![Colourbar for dNDVI product between -1 to +1](/_files/dea-burnt-area/legend_dndvi.png)
![Colourbar for dNDVI product between -1 to +1](/_media/dea-burnt-area/legend_dndvi.png)

## Lineage

Expand Down
4 changes: 2 additions & 2 deletions docs/data/product/dea-coastlines/_access.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,11 @@ By default, the map will show hotspots of coastal change at continental scale. R

More detailed rates of change points will be displayed as you zoom in. To view a time series chart of how a coastal region or area of coastline has changed over time, click on any point (press "Expand" on the pop-up for more detail):

![DEA Maps zoom example](/_files/cmi/DEACoastLines_DEAMaps_1.gif)
![DEA Maps zoom example](/_media/cmi/DEACoastLines_DEAMaps_1.gif)

Zoom in further to view individual annual shorelines:

![DEA Maps coastlines example](/_files/cmi/DEACoastLines_DEAMaps_2.gif)
![DEA Maps coastlines example](/_media/cmi/DEACoastLines_DEAMaps_2.gif)

**Note:** To view a DEA Coastlines layer that is not currently visible (e.g. rates of change points at full zoom), each layer can be added to the map individually from the `Sea, ocean and coast > DEA Coastlines > Supplementary data` directory.
:::
Expand Down
Loading
Loading