Skip to content

Commit ebeb0bf

Browse files
authored
minor doc sweep (links, reorganize) (#261)
* minor doc sweep (links, reorganize) * more docs update
1 parent f90fb84 commit ebeb0bf

File tree

11 files changed

+101
-92
lines changed

11 files changed

+101
-92
lines changed

LICENSE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ are asked to read the 3rd Party Licenses referenced with those assets.
1919
The MIT License (MIT)
2020
=====================
2121

22-
Copyright (c) 2015 Government of Canada
22+
Copyright (c) 2025 Government of Canada
2323

2424
Permission is hereby granted, free of charge, to any person
2525
obtaining a copy of this software and associated documentation

docs/content/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

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

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

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

4646
In 2015 pygeometa was made publically available in support of the Treasury
47-
Board [Policy on Acceptable Network and Device Use](http://www.tbs-sct.gc.ca/pol/doc-eng.aspx?id=27122).
47+
Board [Policy on Acceptable Network and Device Use](https://www.tbs-sct.gc.ca/pol/doc-eng.aspx?id=27122).

docs/content/reference/formats/iso19139-2.md renamed to docs/content/reference/extensions/iso19139-2.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# ISO 19139-2 Schema Reference
22

3-
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.
3+
This document describes [ISO 19115-2/19139-2 Extensions for acquisition and processing](https://www.iso.org/standard/67039.html) schema extensions in pygeometa.
44

55
## Sections
66

docs/content/reference/formats/iso19139-hnap.md renamed to docs/content/reference/extensions/iso19139-hnap.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# HNAP Schema Reference
22

3-
This documentation focuses on unique HNAP schema specifities in pygeometa.
3+
This document describes HNAP schema extensions in pygeometa.
44

55
### `identification.keywords`
66

@@ -36,7 +36,7 @@ Example of valid HNAP distribution sections:
3636
```yaml
3737
distribution:
3838
waf_fra-CAN:
39-
url: http://dd.weather.gc.ca/model_gem_global/25km/grib2/lat_lon/
39+
url: https://dd.weather.gc.ca/model_gem_global/25km/grib2/lat_lon/
4040
type: WWW:LINK
4141
name:
4242
en: MSC Datamart
@@ -51,7 +51,7 @@ distribution:
5151
function: download
5252

5353
waf_eng-CAN:
54-
url: http://dd.weather.gc.ca/model_gem_global/25km/grib2/lat_lon/
54+
url: https://dd.weather.gc.ca/model_gem_global/25km/grib2/lat_lon/
5555
type: WWW:LINK
5656
name:
5757
en: MSC Datamart
@@ -66,7 +66,7 @@ distribution:
6666
function: download
6767

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

8181
wms_fra-CAN:
82-
url: http://geo.weather.gc.ca/geomet/?lang=E&service=WMS&request=GetCapabilities&layers=GDPS.ETA_TT
82+
url: https://geo.weather.gc.ca/geomet/?lang=E&service=WMS&request=GetCapabilities&layers=GDPS.ETA_TT
8383
hnap_contenttype:
8484
en: Web Service
8585
fr: Service Web

docs/content/reference/formats/wmo-cmp.md renamed to docs/content/reference/extensions/wmo-cmp.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# WMO Core Metadata Profile Schema Reference
22

3-
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
4-
enhancements in pygeometa.
3+
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.
54

65
## Sections
76

docs/content/reference/formats/wmo-wcmp2.md renamed to docs/content/reference/extensions/wmo-wcmp2.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# WMO Core Metadata Profile 2 (WCMP2) Schema Reference
22

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

66
## Sections
77

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

1616
pygeometa WCMP2 support includes the following `keywords` sections.
1717

18-
* `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).
18+
* `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).
1919

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

2222
## Validation
2323

docs/content/reference/formats/wmo-wigos.md renamed to docs/content/reference/extensions/wmo-wigos.md

Lines changed: 17 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,11 @@
11
# WMO WIGOS Metadata Standard Reference
22

3-
This documentation focuses on the [WMO WIGOS Metadata Standard](https://library.wmo.int/opac/doc_num.php?explnum_id=3653) based schema
4-
enhancements in pygeometa.
5-
6-
pygeometa's MCF model for WIGOS Metadata inherits as well as extends the core
7-
MCF constructs.
3+
This document describes [WMO WIGOS Metadata Standard](https://library.wmo.int/opac/doc_num.php?explnum_id=3653) schema
4+
extensions in pygeometa.
85

96
## Codes
107

11-
Codes for WMO WIGOS are available at http://codes.wmo.int/wmdr
8+
Codes for WMO WIGOS are available at https://codes.wmo.int/wmdr
129

1310
## Sections
1411

@@ -35,11 +32,11 @@ Property Name|Mandatory/Optional|Description|Example|Reference
3532
-------------|------------------|-----------|-------|---------:
3633
identifier|Mandatory|WMO WIGOS identifier|0-20008-0-JFJ|WIGOS Metadata Representation, Section 8.6.4
3734
name|Mandatory|||WIGOS Metadata Representation, Section 4.3
38-
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
39-
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
35+
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
36+
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
4037
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
4138
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
42-
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
39+
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
4340

4441
#### `territory`
4542

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

5047
Property Name|Mandatory/Optional|Description|Example|Reference
5148
-------------|------------------|-----------|-------|---------:
52-
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
49+
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
5350
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
5451

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

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

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

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

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

8885
Property Name|Mandatory/Optional|Description|Example|Reference
8986
-------------|------------------|-----------|-------|---------:
90-
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
87+
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
9188
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
9289

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

9794
Property Name|Mandatory/Optional|Description|Example|Reference
9895
-------------|------------------|-----------|-------|---------:
99-
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
100-
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
96+
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
97+
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
10198
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
10299

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

107104
Property Name|Mandatory/Optional|Description|Example|Reference
108105
-------------|------------------|-----------|-------|---------:
109-
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
106+
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
110107
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
111108

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

116113
Property Name|Mandatory/Optional|Description|Example|Reference
117114
-------------|------------------|-----------|-------|---------:
118-
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
119-
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
120-
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
121-
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
115+
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
116+
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
117+
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
118+
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
122119
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
123120

124121
#### `observations`

docs/content/reference/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
* [Metadata Control File](mcf.md)
44
* Formats
5-
* [iso19139](formats/iso19139-2.md), [specification](http://www.iso.org/iso/catalogue_detail.htm?csnumber=32557)
6-
* [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)
7-
* [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)
8-
* [wmo-wcmp2](formats/wmo-wcmp2.md), [draft specification](https://github.com/wmo-im/wcmp2)
9-
* [wmo-wigos](formats/wmo-wigos.md), [specification](https://library.wmo.int/opac/doc_num.php?explnum_id=3653)
5+
* [iso19139](extensions/iso19139-2.md), [specification](https://www.iso.org/standard/57104.html)
6+
* [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)
7+
* [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)
8+
* [wmo-wcmp2](extensions/wmo-wcmp2.md), [specification](https://wmo-im.github.io/wcmp2/standard/wcmp2-STABLE.html)
9+
* [wmo-wigos](extensions/wmo-wigos.md), [specification](https://library.wmo.int/opac/doc_num.php?explnum_id=3653)

0 commit comments

Comments
 (0)