Resource standard · v1
What it takes to enter a registry.
One standard, three registries. The common fields apply to every resource; each registry adds the fields its kind needs. Missing fields block a release.
Common fields
Required for every resource.
- Geography & time
geography_time - Spatial extent, spatial unit or resolution, time span, and update cadence.
- Provenance
provenance - Original sources, how they were obtained, and the rights attached to them.
- Processing
processing - Every step between the source and the released resource, with the code that performs it.
- Validation
validation - How the resource was checked, against what, and the results of those checks.
- Limitations
limitations - Known gaps, biases, and misuse risks.
- Licence, access & citation
versionlicenseaccesslinkscitation - The licence of the release, any access conditions, what may not be redistributed, a version, and how to cite the resource.
Registry 01
Dataset fields.
Coverage & time
geography_timeExtent, spatial unit or raster resolution, coordinate reference system, period covered, observation dates, and update cadence.Variables & schema
variables_schemaEvery field with its type, unit, allowed values, and missing-value convention.Source & collection
provenanceOriginal providers, collection method, sampling, and the rights attached to each source.Processing
processingCleaning, joining, aggregation, and derivation steps, with the code that performs them.Validation & quality
validationCompleteness, consistency checks, comparison with reference data, and known error rates.Limitations
limitationsCoverage gaps, biases, temporal mismatches, and uses the dataset does not support.Licence, access & citation
version license access links citationDownload or access route, format, version, licence, and citation.Registry 02
Indicator fields.
Definition & rationale
definitionWhat the indicator is meant to measure, the concept behind it, and why this operationalisation.Inputs
provenanceThe datasets it is computed from, with versions, and any parameters or thresholds used.Computation
processingThe formula or algorithm, step by step, with the code that implements it.Spatial unit & scale
spatial_scaleThe unit the indicator is reported at, and how it behaves when aggregated or disaggregated.Coverage & time
geography_timePlaces and periods for which values are released.Validation
validationAgreement with ground truth, surveys, or established measures, and the results of those comparisons.Sensitivity & uncertainty
sensitivityHow the indicator responds to parameter choices and input errors, and how uncertainty is reported.Limitations & misuse
limitationsContexts where the indicator is not valid, and interpretations it does not support.Licence, access & citation
version license access links citationComputed values, code, version, licence, and citation.Registry 03
Method fields.
Problem & intended users
problem_usersThe urban question the method answers and who is expected to run it.Inputs & outputs
inputs_outputsRequired inputs with formats and sources, and the outputs produced with their schema.Data sources
provenanceData the method was developed and tested on, and the rights attached to it.Steps & dependencies
processingThe pipeline in order, with software dependencies and their versions.Installation & runtime
installation_runtimeHow to set up the environment, expected run time, and hardware requirements.Example & test data
exampleA worked example with small test data that reproduces a published result.Tested geography
geography_timePlaces and periods where the method has been applied and checked.Validation
validationHow outputs were checked, including comparison with alternative methods where they exist.Maintenance status
maintenanceWhether the method is maintained, who maintains it, and known open issues.Limitations
limitationsKnown gaps, biases, and misuse risks.Licence, access & citation
version license access links citationRepository, release version, licence, and citation.Release checklist
Before a resource goes live.
Card completeEvery required field is filled. “To follow” is not an accepted value.
RegenerableThe processing code runs from the documented sources and reproduces the released resource.
Rights checkedSource licences permit the release; restricted or personal data is described, not redistributed.
Version assignedThe resource carries a version, a release date, and a citation; later changes get a new version.
Status & versioning
How resources change over time.
draftCard in preparation. Stored in the repository but not shown on the registry pages.
releasedCard complete and artifacts public. Shown on the registry page with its version.
deprecatedSuperseded or withdrawn. Remains listed for the record, with a pointer to its replacement where one exists.
VersionsSemantic versions. A change to sources, processing, definition, or schema increments the version; downstream resources state which version they used.
Out of scope
What is not accepted.
Download links without documentationFiles with no provenance, processing history, or licence.
Indicators without a definitionComputed values with no statement of what they measure or how they were validated.
Methods that do not runCode without an environment, example, or output that can be checked.
Restricted or personal dataMaterial the submitter does not have the right to release, or that identifies individuals.
Propose a resource
Open an issue with the card attached.
Proposals and data requests are reviewed against this standard in the public repository. Corrections to existing resources follow the same route.