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

minor doc sweep (links, reorganize) #261

Merged
merged 2 commits into from
Mar 11, 2025
Merged
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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ are asked to read the 3rd Party Licenses referenced with those assets.
The MIT License (MIT)
=====================

Copyright (c) 2015 Government of Canada
Copyright (c) 2025 Government of Canada

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
Expand Down
6 changes: 3 additions & 3 deletions docs/content/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

pygeometa provides a lightweight and Pythonic approach for users to easily
create geospatial metadata in standards-based formats using simple
configuration files (affectionately called metadata control files [MCF]).
configuration files (affectionately called Metadata Control Files [MCF]).
Leveraging the simple but powerful YAML format, pygeometa can generate metadata
in numerous standards. Users can also create their own custom metadata formats
which can be plugged into pygeometa for custom metadata format output.
Expand All @@ -20,7 +20,7 @@ The project supports various metadata formats out of the box including ISO
find the format you're looking for? Element(s) missing from a given format?
Feel free to open an [issue](https://github.com/geopython/pygeometa/issues)!

pygeometa has minimal dependencies (install is less than 50 kB), and provides
pygeometa has minimal dependencies (wheel install is less than 100 kB), and provides
a flexible extension mechanism leveraging the Jinja2 templating system.

pygeometa is [open source](https://opensource.org) and released under an
Expand All @@ -44,4 +44,4 @@ pulled out of pygdm to focus on the core requirement of generating geospatial
metadata within a real-time environment and automated workflows.

In 2015 pygeometa was made publically available in support of the Treasury
Board [Policy on Acceptable Network and Device Use](http://www.tbs-sct.gc.ca/pol/doc-eng.aspx?id=27122).
Board [Policy on Acceptable Network and Device Use](https://www.tbs-sct.gc.ca/pol/doc-eng.aspx?id=27122).
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# ISO 19139-2 Schema Reference

This documentation focuses on the [ISO 19115-2/19139-2 Extensions for acquisition and processing](https://www.iso.org/standard/67039.html) based schema enhancements in pygeometa.
This document describes [ISO 19115-2/19139-2 Extensions for acquisition and processing](https://www.iso.org/standard/67039.html) schema extensions in pygeometa.

## Sections

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# HNAP Schema Reference

This documentation focuses on unique HNAP schema specifities in pygeometa.
This document describes HNAP schema extensions in pygeometa.

### `identification.keywords`

Expand Down Expand Up @@ -36,7 +36,7 @@ Example of valid HNAP distribution sections:
```yaml
distribution:
waf_fra-CAN:
url: http://dd.weather.gc.ca/model_gem_global/25km/grib2/lat_lon/
url: https://dd.weather.gc.ca/model_gem_global/25km/grib2/lat_lon/
type: WWW:LINK
name:
en: MSC Datamart
Expand All @@ -51,7 +51,7 @@ distribution:
function: download

waf_eng-CAN:
url: http://dd.weather.gc.ca/model_gem_global/25km/grib2/lat_lon/
url: https://dd.weather.gc.ca/model_gem_global/25km/grib2/lat_lon/
type: WWW:LINK
name:
en: MSC Datamart
Expand All @@ -66,7 +66,7 @@ distribution:
function: download

wms_eng-CAN:
url: http://geo.weather.gc.ca/geomet/?lang=E&service=WMS&request=GetCapabilities&layers=GDPS.ETA_TT
url: https://geo.weather.gc.ca/geomet/?lang=E&service=WMS&request=GetCapabilities&layers=GDPS.ETA_TT
hnap_contenttype:
en: Web Service
fr: Service Web
Expand All @@ -79,7 +79,7 @@ distribution:
function: download

wms_fra-CAN:
url: http://geo.weather.gc.ca/geomet/?lang=E&service=WMS&request=GetCapabilities&layers=GDPS.ETA_TT
url: https://geo.weather.gc.ca/geomet/?lang=E&service=WMS&request=GetCapabilities&layers=GDPS.ETA_TT
hnap_contenttype:
en: Web Service
fr: Service Web
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# WMO Core Metadata Profile Schema Reference

This documentation focuses on the [WMO Core Metadata Profile](http://wis.wmo.int/2013/metadata/version_1-3-0/WMO_Core_Metadata_Profile_v1.3_Part_1.pdf) based schema
enhancements in pygeometa.
This document describes [WMO Core Metadata Profile](https://wis.wmo.int/2013/metadata/version_1-3-0/WMO_Core_Metadata_Profile_v1.3_Part_1.pdf) schema extensions in pygeometa.

## Sections

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# WMO Core Metadata Profile 2 (WCMP2) Schema Reference

This documentation focuses on the draft [WMO Core Metadata Profile](https://github.com/wmo-im/wcmp2) based schema
enhancements in pygeometa.
This document describes [WMO Core Metadata Profile (WCMP2)](https://wmo-im.github.io/wcmp2/standard/wcmp2-STABLE.html) schema
extensions in pygeometa.

## Sections

Expand All @@ -15,9 +15,9 @@ wmo_data_policy|Mandatory|WMO data policy as per Resolution 1 (Cg-Ext(2021) (`co

pygeometa WCMP2 support includes the following `keywords` sections.

* `earth-system-discipline`: [Earth system categories](https://github.com/wmo-im/wis2-topic-hierarchy/blob/main/topic-hierarchy/earth-system-discipline.csv) as defined by the [WMO Unified Data Policy, Resolution 1 (Cg-Ext(2021), Annex 1](https://library.wmo.int/records/item/58009-wmo-unified-data-policy).
* `earth-system-discipline`: [Earth system categories](https://codes.wmo.int/wis/topic-hierarchy/earth-system-discipline) as defined by the [WMO Unified Data Policy, Resolution 1 (Cg-Ext(2021), Annex 1](https://library.wmo.int/records/item/58009-wmo-unified-data-policy).

Ensure that `vocabulary.url` is set to https://github.com/wmo-im/wis2-topic-hierarchy/blob/main/topic-hierarchy/earth-system-discipline.csv).
Ensure that `vocabulary.url` is set to https://codes.wmo.int/wis/topic-hierarchy/earth-system-discipline

## Validation

Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,11 @@
# WMO WIGOS Metadata Standard Reference

This documentation focuses on the [WMO WIGOS Metadata Standard](https://library.wmo.int/opac/doc_num.php?explnum_id=3653) based schema
enhancements in pygeometa.

pygeometa's MCF model for WIGOS Metadata inherits as well as extends the core
MCF constructs.
This document describes [WMO WIGOS Metadata Standard](https://library.wmo.int/opac/doc_num.php?explnum_id=3653) schema
extensions in pygeometa.

## Codes

Codes for WMO WIGOS are available at http://codes.wmo.int/wmdr
Codes for WMO WIGOS are available at https://codes.wmo.int/wmdr

## Sections

Expand All @@ -35,11 +32,11 @@ Property Name|Mandatory/Optional|Description|Example|Reference
-------------|------------------|-----------|-------|---------:
identifier|Mandatory|WMO WIGOS identifier|0-20008-0-JFJ|WIGOS Metadata Representation, Section 8.6.4
name|Mandatory|||WIGOS Metadata Representation, Section 4.3
type|Mandatory|The type of the observing facility from the Station/platform type codelist (http://codes.wmo.int/wmdr/_FacilityType)|landFixed|WIGOS Metadata Representation, Section 4.3.2
geopositioning_method|Optional|Element describes the geospatial reference system used for the specified geolocation (codelist http://codes.wmo.int/wmdr/_GeopositioningMethod)|gps|WIGOS Metadata Representation, Section 4.2.2
type|Mandatory|The type of the observing facility from the Station/platform type codelist (https://codes.wmo.int/wmdr/_FacilityType)|landFixed|WIGOS Metadata Representation, Section 4.3.2
geopositioning_method|Optional|Element describes the geospatial reference system used for the specified geolocation (codelist https://codes.wmo.int/wmdr/_GeopositioningMethod)|gps|WIGOS Metadata Representation, Section 4.2.2
url|Optional|An online resource containing additional information about the facility or equipment|https://example.org/station/123|WIGOS Metadata Representation, Section 4.2.2
date_established|Mandatory|Date at which the observingFacility was established. Normally considered to be the date the first observations were made|2011-11-11T11:11:11Z|WIGOS Metadata Representation, Section 4.3.2
wmo_region|Mandatory|The WMO region the observing facility is located in, from the WMORegionType codelist (http://codes.wmo.int/wmdr/_WMORegion)|northCentralAmericaCaribbean|WIGOS Metadata Representation, Section 4.3.2
wmo_region|Mandatory|The WMO region the observing facility is located in, from the WMORegionType codelist (https://codes.wmo.int/wmdr/_WMORegion)|northCentralAmericaCaribbean|WIGOS Metadata Representation, Section 4.3.2

#### `territory`

Expand All @@ -49,7 +46,7 @@ over time. At least one child object is required.

Property Name|Mandatory/Optional|Description|Example|Reference
-------------|------------------|-----------|-------|---------:
name|Mandatory|The territory the observing facility is located in, from the TerritoryType codelist (http://codes.wmo.int/wmdr/_TerritoryName)|`CAN`|WIGOS Metadata Representation, Section 4.3.2
name|Mandatory|The territory the observing facility is located in, from the TerritoryType codelist (https://codes.wmo.int/wmdr/_TerritoryName)|`CAN`|WIGOS Metadata Representation, Section 4.3.2
valid_period|Optional|Specifies at least the begin date of the indicated territoryName. If omitted, the dateEstablished of the facility will be assumed|`begin: 2011-11-11`, `end: now`|WIGOS Metadata Representation, Section 4.3.2

#### `spatiotemporal`
Expand All @@ -69,7 +66,7 @@ allows for specifying 1..n child objects to model program affiliations.

Property Name|Mandatory/Optional|Description|Example|Reference
-------------|------------------|-----------|-------|---------:
program|Mandatory|Program Affiliation, see http://codes.wmo.int/wmdr/_ProgramAffiliation|`GOS`|WIGOS Metadata Representation, Section 4.3.2
program|Mandatory|Program Affiliation, see https://codes.wmo.int/wmdr/_ProgramAffiliation|`GOS`|WIGOS Metadata Representation, Section 4.3.2

#### `reporting_status`
The `reporting_status` object is a child of the `program_affiliation` object and
Expand All @@ -78,7 +75,7 @@ over time.

Property Name|Mandatory/Optional|Description|Example|Reference
-------------|------------------|-----------|-------|---------:
status|Mandatory|Declared reporting status of the observing facility from the ReportingStatusType codelist (http://codes.wmo.int/wmdr/_ReportingStatus)|`operational`|
status|Mandatory|Declared reporting status of the observing facility from the ReportingStatusType codelist (https://codes.wmo.int/wmdr/_ReportingStatus)|`operational`|
valid_period|Optional|Specifies at least the begin date of the indicated reportingStatus.|`begin: 2011-11-11`, `end: now`|

#### `climate_zone`
Expand All @@ -87,7 +84,7 @@ allows for specifying 0..n child objects to model changing climate zones over ti

Property Name|Mandatory/Optional|Description|Example|Reference
-------------|------------------|-----------|-------|---------:
name|Mandatory|Climate zone of the observing facility, from the ClimateZone codelist (http://codes.wmo.int/wmdr/_ClimateZone)|`snowFullyHumidCoolSummer`|WIGOS Metadata Representation, Section 4.3.2
name|Mandatory|Climate zone of the observing facility, from the ClimateZone codelist (https://codes.wmo.int/wmdr/_ClimateZone)|`snowFullyHumidCoolSummer`|WIGOS Metadata Representation, Section 4.3.2
valid_period|Optional|Specifies at least the begin date of the indicated climate zone. If omitted, the dateEstablished of the facility will be assumed|`begin: 2011-11-11`, `end: now`|WIGOS Metadata Representation, Section 4.3.2

#### `surface_cover`
Expand All @@ -96,8 +93,8 @@ allows for specifying 0..n child objects to model changing surface covers over t

Property Name|Mandatory/Optional|Description|Example|Reference
-------------|------------------|-----------|-------|---------:
name|Mandatory|Predominant surface cover, from the given surface cover classification scheme and the SurfaceCover codelist (http://codes.wmo.int/wmdr/_SurfaceCover)|`rainfedCroplands`|WIGOS Metadata Representation, Section 4.3.2
surface_cover_classification|Mandatory|Surface cover classification scheme, from the SurfaceCoverClassification codelist (http://codes.wmo.int/wmdr/_SurfaceCoverClassification)|`globCover2009`|WIGOS Metadata Representation, Section 4.3.2
name|Mandatory|Predominant surface cover, from the given surface cover classification scheme and the SurfaceCover codelist (https://codes.wmo.int/wmdr/_SurfaceCover)|`rainfedCroplands`|WIGOS Metadata Representation, Section 4.3.2
surface_cover_classification|Mandatory|Surface cover classification scheme, from the SurfaceCoverClassification codelist (https://codes.wmo.int/wmdr/_SurfaceCoverClassification)|`globCover2009`|WIGOS Metadata Representation, Section 4.3.2
valid_period|Optional|Specifies at least the begin date. If omitted, the dateEstablished of the facility will be assumed|`begin: 2011-11-11`, `end: now`|WIGOS Metadata Representation, Section 4.3.2

#### `surface_roughness`
Expand All @@ -106,7 +103,7 @@ allows for specifying 0..n child objects.

Property Name|Mandatory/Optional|Description|Example|Reference
-------------|------------------|-----------|-------|---------:
name|Mandatory|Surface roughness of surrounding of the observing facility, from the SurfaceRoughness codelist (http://codes.wmo.int/wmdr/_SurfaceRoughness)|`rough`|WIGOS Metadata Representation, Section 4.3.2
name|Mandatory|Surface roughness of surrounding of the observing facility, from the SurfaceRoughness codelist (https://codes.wmo.int/wmdr/_SurfaceRoughness)|`rough`|WIGOS Metadata Representation, Section 4.3.2
valid_period|Optional|Specifies at least the begin date of the indicated surface roughness. If omitted, the dateEstablished of the facility will be assumed|`begin: 2011-11-11`, `end: now`|WIGOS Metadata Representation, Section 4.3.2

#### `topography_bathymetry`
Expand All @@ -115,10 +112,10 @@ allows for specifying 0..n child objects to model topography or bathymetry descr

Property Name|Mandatory/Optional|Description|Example|Reference
-------------|------------------|-----------|-------|---------:
local_topography|Optional|Local topography of the observing facility from the LocalTopography codelist (http://codes.wmo.int/wmdr/_LocalTopography)|`flat`|WIGOS Metadata Representation, Section 4.3.2
relative_elevation|Optional|Relative elevation of the observing facility compared to its surrounding, from the RelativeElevation codelist (http://codes.wmo.int/wmdr/_RelativeElevation)|`inapplicable`|WIGOS Metadata Representation, Section 4.3.2
topographic_context|Optional|Topographic context of the observing facility, from the TopographicContext codelist (http://codes.wmo.int/wmdr/_TopographicContext)|`plains`|WIGOS Metadata Representation, Section 4.3.2
altitude_or_depth|Optional|Altitude or depth of observing facility, from the AltitudeOrDepth codelist (http://codes.wmo.int/wmdr/_AltitudeOrDepth)|`middleAltitude`|WIGOS Metadata Representation, Section 4.3.2
local_topography|Optional|Local topography of the observing facility from the LocalTopography codelist (https://codes.wmo.int/wmdr/_LocalTopography)|`flat`|WIGOS Metadata Representation, Section 4.3.2
relative_elevation|Optional|Relative elevation of the observing facility compared to its surrounding, from the RelativeElevation codelist (https://codes.wmo.int/wmdr/_RelativeElevation)|`inapplicable`|WIGOS Metadata Representation, Section 4.3.2
topographic_context|Optional|Topographic context of the observing facility, from the TopographicContext codelist (https://codes.wmo.int/wmdr/_TopographicContext)|`plains`|WIGOS Metadata Representation, Section 4.3.2
altitude_or_depth|Optional|Altitude or depth of observing facility, from the AltitudeOrDepth codelist (https://codes.wmo.int/wmdr/_AltitudeOrDepth)|`middleAltitude`|WIGOS Metadata Representation, Section 4.3.2
valid_period|Optional|Specifies at least the begin date. If omitted, the dateEstablished of the facility will be assumed|`begin: 2011-11-11`, `end: now`|WIGOS Metadata Representation, Section 4.3.2

#### `observations`
Expand Down
10 changes: 5 additions & 5 deletions docs/content/reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

* [Metadata Control File](mcf.md)
* Formats
* [iso19139](formats/iso19139-2.md), [specification](http://www.iso.org/iso/catalogue_detail.htm?csnumber=32557)
* [iso19139-hnap](formats/iso19139-hnap.md), [specification](http://www.gcpedia.gc.ca/wiki/Federal_Geospatial_Platform/Policies_and_Standards/Catalogue/Release/Appendix_B_Guidelines_and_Best_Practices/Guide_to_Harmonized_ISO_19115:2003_NAP)
* [wmo-cmp](formats/wmo-cmp.md), [specification](http://wis.wmo.int/2013/metadata/version_1-3-0/WMO_Core_Metadata_Profile_v1.3_Part_1.pdf)
* [wmo-wcmp2](formats/wmo-wcmp2.md), [draft specification](https://github.com/wmo-im/wcmp2)
* [wmo-wigos](formats/wmo-wigos.md), [specification](https://library.wmo.int/opac/doc_num.php?explnum_id=3653)
* [iso19139](extensions/iso19139-2.md), [specification](https://www.iso.org/standard/57104.html)
* [iso19139-hnap](extensions/iso19139-hnap.md), [specification](https://www.gcpedia.gc.ca/wiki/Federal_Geospatial_Platform/Policies_and_Standards/Catalogue/Release/Appendix_B_Guidelines_and_Best_Practices/Guide_to_Harmonized_ISO_19115:2003_NAP)
* [wmo-cmp](extensions/wmo-cmp.md), [specification](https://wis.wmo.int/2013/metadata/version_1-3-0/WMO_Core_Metadata_Profile_v1.3_Part_1.pdf)
* [wmo-wcmp2](extensions/wmo-wcmp2.md), [specification](https://wmo-im.github.io/wcmp2/standard/wcmp2-STABLE.html)
* [wmo-wigos](extensions/wmo-wigos.md), [specification](https://library.wmo.int/opac/doc_num.php?explnum_id=3653)
Loading