From ee7de10be0a26edce967be5bacf49c2c29d40357 Mon Sep 17 00:00:00 2001 From: Paul Weidner Date: Wed, 2 Oct 2024 02:13:33 -0700 Subject: [PATCH 1/5] Add script to populate taxonomy linkml schema --- schema/scripts/populateSemanticEnums.py | 33 +++ schema/src/taxonomy.yaml | 369 ++++++++++++++++++++++++ 2 files changed, 402 insertions(+) create mode 100644 schema/scripts/populateSemanticEnums.py create mode 100644 schema/src/taxonomy.yaml diff --git a/schema/scripts/populateSemanticEnums.py b/schema/scripts/populateSemanticEnums.py new file mode 100644 index 0000000..9a99a6d --- /dev/null +++ b/schema/scripts/populateSemanticEnums.py @@ -0,0 +1,33 @@ +import glob + +from linkml_runtime.linkml_model import PermissibleValue +from linkml_runtime.utils.schemaview import SchemaView +from linkml_runtime.dumpers import yaml_dumper + +# Load the taxonomy schema into a SchemaView. +taxonomy_schema_path = "../src/taxonomy.yaml" +view = SchemaView(taxonomy_schema_path) + +# Map each taxonomy to the linkml enum. +taxonomies = { + "activity": "ActivityTypes", + "environment-type": "EnvironmentTypeTypes", + "impact": "ImpactTypes", +} + +# Load all taxonomy terms and add to the enums. +for taxonomy, enum_name in taxonomies.items(): + enum = view.get_enum(enum_name) + md_files = glob.glob("**/*.md", root_dir=f"../../src/content/{taxonomy}", recursive=True) + for file in md_files: + enum_text = file.split("/").pop().replace(".md", "").replace(" ", "") + enum_value = PermissibleValue( + title=enum_text, + text=enum_text, + meaning=f"rft:{enum_text}" + ) + enum.permissible_values.update({enum_text: enum_value}) + +# Write back changes to the taxonomy schema file. +with open(taxonomy_schema_path, "w") as f: + f.write(yaml_dumper.dumps(view.schema)) diff --git a/schema/src/taxonomy.yaml b/schema/src/taxonomy.yaml new file mode 100644 index 0000000..54ca69b --- /dev/null +++ b/schema/src/taxonomy.yaml @@ -0,0 +1,369 @@ +name: Taxonomy +id: https://framework.regen.network/taxonomy/ +prefixes: + rfs: + prefix_prefix: rfs + prefix_reference: https://framework.regen.network/schema/ + rft: + prefix_prefix: rft + prefix_reference: https://framework.regen.network/taxonomy/ +default_curi_maps: +- semweb_context +default_prefix: rfs +default_range: string +enums: + ActivityTypes: + name: ActivityTypes + from_schema: https://framework.regen.network/taxonomy/ + permissible_values: + ResidueTillageManagement: + text: ResidueTillageManagement + meaning: rft:ResidueTillageManagement + title: ResidueTillageManagement + BiocharProduction: + text: BiocharProduction + meaning: rft:BiocharProduction + title: BiocharProduction + ImprovedForestManagement: + text: ImprovedForestManagement + meaning: rft:ImprovedForestManagement + title: ImprovedForestManagement + Agroforestry: + text: Agroforestry + meaning: rft:Agroforestry + title: Agroforestry + PrescribedGrazing: + text: PrescribedGrazing + meaning: rft:PrescribedGrazing + title: PrescribedGrazing + RiparianForestBuffers: + text: RiparianForestBuffers + meaning: rft:RiparianForestBuffers + title: RiparianForestBuffers + SoilAmendments: + text: SoilAmendments + meaning: rft:SoilAmendments + title: SoilAmendments + Conservation: + text: Conservation + meaning: rft:Conservation + title: Conservation + Ecotourism: + text: Ecotourism + meaning: rft:Ecotourism + title: Ecotourism + CoverCropping: + text: CoverCropping + meaning: rft:CoverCropping + title: CoverCropping + TreePlanting: + text: TreePlanting + meaning: rft:TreePlanting + title: TreePlanting + PhotocatalystApplication: + text: PhotocatalystApplication + meaning: rft:PhotocatalystApplication + title: PhotocatalystApplication + EcosystemRestoration: + text: EcosystemRestoration + meaning: rft:EcosystemRestoration + title: EcosystemRestoration + IndustrialBiocharProduction: + text: IndustrialBiocharProduction + meaning: rft:IndustrialBiocharProduction + title: IndustrialBiocharProduction + ArtisanalBiocharProduction: + text: ArtisanalBiocharProduction + meaning: rft:ArtisanalBiocharProduction + title: ArtisanalBiocharProduction + Biochar: + text: Biochar + meaning: rft:Biochar + title: Biochar + EnhancedRockWeathering: + text: EnhancedRockWeathering + meaning: rft:EnhancedRockWeathering + title: EnhancedRockWeathering + CompostAmendments: + text: CompostAmendments + meaning: rft:CompostAmendments + title: CompostAmendments + KeystoneSpeciesConservation: + text: KeystoneSpeciesConservation + meaning: rft:KeystoneSpeciesConservation + title: KeystoneSpeciesConservation + UmbrellaSpeciesConservation: + text: UmbrellaSpeciesConservation + meaning: rft:UmbrellaSpeciesConservation + title: UmbrellaSpeciesConservation + Silvopasture: + text: Silvopasture + meaning: rft:Silvopasture + title: Silvopasture + ForestFarming: + text: ForestFarming + meaning: rft:ForestFarming + title: ForestFarming + NonUrbanForestImprovement: + text: NonUrbanForestImprovement + meaning: rft:NonUrbanForestImprovement + title: NonUrbanForestImprovement + UrbanForestImprovement: + text: UrbanForestImprovement + meaning: rft:UrbanForestImprovement + title: UrbanForestImprovement + Afforestation: + text: Afforestation + meaning: rft:Afforestation + title: Afforestation + Reforestation: + text: Reforestation + meaning: rft:Reforestation + title: Reforestation + EnvironmentTypeTypes: + name: EnvironmentTypeTypes + from_schema: https://framework.regen.network/taxonomy/ + permissible_values: + Marine: + text: Marine + meaning: rft:Marine + title: Marine + Cropland: + text: Cropland + meaning: rft:Cropland + title: Cropland + UrbanTrees: + text: UrbanTrees + meaning: rft:UrbanTrees + title: UrbanTrees + Shrubland: + text: Shrubland + meaning: rft:Shrubland + title: Shrubland + Pasture: + text: Pasture + meaning: rft:Pasture + title: Pasture + Savanna: + text: Savanna + meaning: rft:Savanna + title: Savanna + Grassland: + text: Grassland + meaning: rft:Grassland + title: Grassland + AgroforestrySystem: + text: AgroforestrySystem + meaning: rft:AgroforestrySystem + title: AgroforestrySystem + PermanentIce: + text: PermanentIce + meaning: rft:PermanentIce + title: PermanentIce + Wetland: + text: Wetland + meaning: rft:Wetland + title: Wetland + Freshwater: + text: Freshwater + meaning: rft:Freshwater + title: Freshwater + Orchard: + text: Orchard + meaning: rft:Orchard + title: Orchard + AquacultureSystem: + text: AquacultureSystem + meaning: rft:AquacultureSystem + title: AquacultureSystem + Vineyard: + text: Vineyard + meaning: rft:Vineyard + title: Vineyard + Desert: + text: Desert + meaning: rft:Desert + title: Desert + Forest: + text: Forest + meaning: rft:Forest + title: Forest + IrrigatedCropland: + text: IrrigatedCropland + meaning: rft:IrrigatedCropland + title: IrrigatedCropland + RainfedCropland: + text: RainfedCropland + meaning: rft:RainfedCropland + title: RainfedCropland + TemperateShrubland: + text: TemperateShrubland + meaning: rft:TemperateShrubland + title: TemperateShrubland + BorealShrubland: + text: BorealShrubland + meaning: rft:BorealShrubland + title: BorealShrubland + TropicalShrubland: + text: TropicalShrubland + meaning: rft:TropicalShrubland + title: TropicalShrubland + Marsh: + text: Marsh + meaning: rft:Marsh + title: Marsh + Bog: + text: Bog + meaning: rft:Bog + title: Bog + Swamp: + text: Swamp + meaning: rft:Swamp + title: Swamp + TropicalForest: + text: TropicalForest + meaning: rft:TropicalForest + title: TropicalForest + TemperateForest: + text: TemperateForest + meaning: rft:TemperateForest + title: TemperateForest + BorealForest: + text: BorealForest + meaning: rft:BorealForest + title: BorealForest + Coastal: + text: Coastal + meaning: rft:Coastal + title: Coastal + DeepWater: + text: DeepWater + meaning: rft:DeepWater + title: DeepWater + CoralReef: + text: CoralReef + meaning: rft:CoralReef + title: CoralReef + TemperateGrassland: + text: TemperateGrassland + meaning: rft:TemperateGrassland + title: TemperateGrassland + Tundra: + text: Tundra + meaning: rft:Tundra + title: Tundra + TropicalGrassland: + text: TropicalGrassland + meaning: rft:TropicalGrassland + title: TropicalGrassland + Lake: + text: Lake + meaning: rft:Lake + title: Lake + Watercourse: + text: Watercourse + meaning: rft:Watercourse + title: Watercourse + ImpactTypes: + name: ImpactTypes + from_schema: https://framework.regen.network/taxonomy/ + permissible_values: + ReducedFertilizerAmendments: + text: ReducedFertilizerAmendments + meaning: rft:ReducedFertilizerAmendments + title: ReducedFertilizerAmendments + AvoidedDeforestationDegradation: + text: AvoidedDeforestationDegradation + meaning: rft:AvoidedDeforestationDegradation + title: AvoidedDeforestationDegradation + ImprovedCulturalHeritageAwareness: + text: ImprovedCulturalHeritageAwareness + meaning: rft:ImprovedCulturalHeritageAwareness + title: ImprovedCulturalHeritageAwareness + ImprovedBiodiversity: + text: ImprovedBiodiversity + meaning: rft:ImprovedBiodiversity + title: ImprovedBiodiversity + ImprovedEnvironmentalEducationOutreach: + text: ImprovedEnvironmentalEducationOutreach + meaning: rft:ImprovedEnvironmentalEducationOutreach + title: ImprovedEnvironmentalEducationOutreach + ReducedSoilErosion: + text: ReducedSoilErosion + meaning: rft:ReducedSoilErosion + title: ReducedSoilErosion + ReducedHerbicideAmendments: + text: ReducedHerbicideAmendments + meaning: rft:ReducedHerbicideAmendments + title: ReducedHerbicideAmendments + ImprovedForestHealth: + text: ImprovedForestHealth + meaning: rft:ImprovedForestHealth + title: ImprovedForestHealth + ImprovedCommunityHealth: + text: ImprovedCommunityHealth + meaning: rft:ImprovedCommunityHealth + title: ImprovedCommunityHealth + ImprovedWildlifeHabitat: + text: ImprovedWildlifeHabitat + meaning: rft:ImprovedWildlifeHabitat + title: ImprovedWildlifeHabitat + ImprovedSoilHealth: + text: ImprovedSoilHealth + meaning: rft:ImprovedSoilHealth + title: ImprovedSoilHealth + IncreasedForestCover: + text: IncreasedForestCover + meaning: rft:IncreasedForestCover + title: IncreasedForestCover + ReducedPesticideAmendments: + text: ReducedPesticideAmendments + meaning: rft:ReducedPesticideAmendments + title: ReducedPesticideAmendments + ImprovedWaterInfiltration: + text: ImprovedWaterInfiltration + meaning: rft:ImprovedWaterInfiltration + title: ImprovedWaterInfiltration + ImprovedWaterHoldingCapacity: + text: ImprovedWaterHoldingCapacity + meaning: rft:ImprovedWaterHoldingCapacity + title: ImprovedWaterHoldingCapacity + IncreasedCarbonSequestrationStorage: + text: IncreasedCarbonSequestrationStorage + meaning: rft:IncreasedCarbonSequestrationStorage + title: IncreasedCarbonSequestrationStorage + ReducedIrrigation: + text: ReducedIrrigation + meaning: rft:ReducedIrrigation + title: ReducedIrrigation + ImprovedSoilStructure: + text: ImprovedSoilStructure + meaning: rft:ImprovedSoilStructure + title: ImprovedSoilStructure + ImprovedNutrientCycling: + text: ImprovedNutrientCycling + meaning: rft:ImprovedNutrientCycling + title: ImprovedNutrientCycling +slots: + activity: + name: activity + description: The types of activities being implemented in projects + from_schema: https://framework.regen.network/taxonomy/ + slot_uri: rfs:activity + range: ActivityTypes + multivalued: true + environmentType: + name: environmentType + description: General classification of the project's environment type. + from_schema: https://framework.regen.network/taxonomy/ + slot_uri: rfs:environmentType + range: EnvironmentTypeTypes + multivalued: true + impact: + name: impact + description: A project or initiative’s current and potential impact + from_schema: https://framework.regen.network/taxonomy/ + slot_uri: rfs:impact + range: ImpactTypes + multivalued: true +source_file: ../src/taxonomy.yaml From 02eb62e7afd5259b8fefe294c9e7ee7c3c76e3d7 Mon Sep 17 00:00:00 2001 From: Paul Weidner Date: Wed, 2 Oct 2024 02:14:02 -0700 Subject: [PATCH 2/5] Add activity, impact and environmentType slots to project --- schema/src/project.yaml | 47 ++++------------------------------------- schema/src/schemas.yaml | 1 + 2 files changed, 5 insertions(+), 43 deletions(-) diff --git a/schema/src/project.yaml b/schema/src/project.yaml index f8ae1b1..c110360 100644 --- a/schema/src/project.yaml +++ b/schema/src/project.yaml @@ -8,6 +8,7 @@ prefixes: unit: http://qudt.org/vocab/unit/ imports: - linkml:types + - taxonomy default_curi_maps: - semweb_context default_prefix: rfs @@ -28,7 +29,6 @@ classes: - biomeType - watershed - subWatershed - - environmentType - offchainCreditsInfo - projectDuration - managementAreas @@ -41,10 +41,12 @@ classes: - projectVerifier - projectDeveloper - creditClassVersion + - activity + - environmentType + - impact attributes: size: range: integer - activity: start_date: end_date: project_type: @@ -170,11 +172,6 @@ slots: range: string slot_uri: rfs:subWatershed description: The sub-watershed associated with the project. - environmentType: - slot_uri: rfs:environmentType - range: EnvironmentTypeTypes - description: The type of environment associated with the project. - multivalued: true environmentalAuthority: slot_uri: rfs:environmentalAuthority range: Organization @@ -204,12 +201,6 @@ slots: description: The management areas associated with the project. multivalued: true inlined: true - activity: - # TODO: associate with regen data standards activities - slot_uri: rfs:activity - range: ActivityTypes - description: the activity. - multivalued: true extent: slot_uri: dcterms:extent range: QuantityValue @@ -257,33 +248,3 @@ enums: voluntary: meaning: rfs:VoluntaryMarket description: a voluntary market - # TODO: these should be imported from a shared vocabulary - EnvironmentTypeTypes: - description: The type of ecosystem - permissible_values: - cloudForest: - meaning: rfs:CloudForest - tropicalSavannah: - meaning: rfs:TropicalSavannah - tropicalDryForest: - meaning: rfs:TropicalDryForest - tropicalForest: - meaning: rfs:TropicalForest - tropicalVeryHumidForest: - meaning: rfs:TropicalVeryHumidForest - tropicalHumidForest: - meaning: rfs:TropicalHumidForest - premontaneHumidForest: - meaning: rfs:PremontaneHumidForest - lowMontaneVeryHumidForest: - meaning: rfs:LowMontaneVeryHumidForest - # TODO: these should be imported from a shared vocabulary - ActivityTypes: - description: The type of activity - permissible_values: - conservation: - meaning: rfs:Conservation - description: a conservation activity - ecosystemRestoration: - meaning: rfs:EcosystemRestoration - description: an ecosystem restoration activity diff --git a/schema/src/schemas.yaml b/schema/src/schemas.yaml index b7c1654..f5a700a 100644 --- a/schema/src/schemas.yaml +++ b/schema/src/schemas.yaml @@ -10,6 +10,7 @@ imports: - linkml:types - project - project-post + - taxonomy default_curi_maps: - semweb_context default_prefix: rfs From 1a2480ce83d82c4e78de4aeb096f84acb74b3baf Mon Sep 17 00:00:00 2001 From: Paul Weidner Date: Thu, 3 Oct 2024 11:03:40 -0700 Subject: [PATCH 3/5] Update schema readme --- schema/README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/schema/README.md b/schema/README.md index 720576d..41df871 100644 --- a/schema/README.md +++ b/schema/README.md @@ -12,5 +12,9 @@ - Create separate schema files for each logical schema class and `import` into the root `schemas.yaml` file. - Generated markdown from schemas: ```shell - gen-doc schema/src/schemas.yml --directory schema/generated --diagram-type er_diagram + gen-doc schema/src/schemas.yaml --directory schema/generated --diagram-type er_diagram + ``` +- Generate linkml enums for taxonomy terms: + ```shell + python populateSemanticEnums.py ``` \ No newline at end of file From 4f20f346abbae1732beeaf9cbc8497e46f4ae1bf Mon Sep 17 00:00:00 2001 From: Paul Weidner Date: Thu, 3 Oct 2024 11:07:19 -0700 Subject: [PATCH 4/5] Run gen-doc --- schema/generated/ActivityTypes.md | 148 ++++++++++++++-- schema/generated/AdministrativeArea.md | 93 +++++++--- schema/generated/EnvironmentTypeTypes.md | 215 +++++++++++++++++++---- schema/generated/ImpactTypes.md | 149 ++++++++++++++++ schema/generated/ManagementArea.md | 4 +- schema/generated/OffchainCreditsInfo.md | 125 ++++++++++--- schema/generated/Project.md | 78 ++++---- schema/generated/activity.md | 6 +- schema/generated/administrativeArea.md | 82 +++++++++ schema/generated/description.md | 4 +- schema/generated/environmentType.md | 4 +- schema/generated/image.md | 2 +- schema/generated/impact.md | 86 +++++++++ schema/generated/index.md | 10 +- schema/generated/name.md | 4 +- schema/generated/offchainCreditsInfo.md | 83 +++++++++ schema/generated/url.md | 2 +- 17 files changed, 947 insertions(+), 148 deletions(-) create mode 100644 schema/generated/ImpactTypes.md create mode 100644 schema/generated/administrativeArea.md create mode 100644 schema/generated/impact.md create mode 100644 schema/generated/offchainCreditsInfo.md diff --git a/schema/generated/ActivityTypes.md b/schema/generated/ActivityTypes.md index b2da0c1..54fa915 100644 --- a/schema/generated/ActivityTypes.md +++ b/schema/generated/ActivityTypes.md @@ -2,19 +2,38 @@ - -_The type of activity_ - - - URI: [ActivityTypes](ActivityTypes.md) ## Permissible Values | Value | Meaning | Description | | --- | --- | --- | -| conservation | rfs:Conservation | a conservation activity | -| ecosystemRestoration | rfs:EcosystemRestoration | an ecosystem restoration activity | +| ResidueTillageManagement | rft:ResidueTillageManagement | | +| BiocharProduction | rft:BiocharProduction | | +| ImprovedForestManagement | rft:ImprovedForestManagement | | +| Agroforestry | rft:Agroforestry | | +| PrescribedGrazing | rft:PrescribedGrazing | | +| RiparianForestBuffers | rft:RiparianForestBuffers | | +| SoilAmendments | rft:SoilAmendments | | +| Conservation | rft:Conservation | | +| Ecotourism | rft:Ecotourism | | +| CoverCropping | rft:CoverCropping | | +| TreePlanting | rft:TreePlanting | | +| PhotocatalystApplication | rft:PhotocatalystApplication | | +| EcosystemRestoration | rft:EcosystemRestoration | | +| IndustrialBiocharProduction | rft:IndustrialBiocharProduction | | +| ArtisanalBiocharProduction | rft:ArtisanalBiocharProduction | | +| Biochar | rft:Biochar | | +| EnhancedRockWeathering | rft:EnhancedRockWeathering | | +| CompostAmendments | rft:CompostAmendments | | +| KeystoneSpeciesConservation | rft:KeystoneSpeciesConservation | | +| UmbrellaSpeciesConservation | rft:UmbrellaSpeciesConservation | | +| Silvopasture | rft:Silvopasture | | +| ForestFarming | rft:ForestFarming | | +| NonUrbanForestImprovement | rft:NonUrbanForestImprovement | | +| UrbanForestImprovement | rft:UrbanForestImprovement | | +| Afforestation | rft:Afforestation | | +| Reforestation | rft:Reforestation | | @@ -23,7 +42,7 @@ URI: [ActivityTypes](ActivityTypes.md) | Name | Description | | --- | --- | -| [activity](activity.md) | the activity | +| [activity](activity.md) | The types of activities being implemented in projects | @@ -53,18 +72,113 @@ URI: [ActivityTypes](ActivityTypes.md)
```yaml name: ActivityTypes -description: The type of activity from_schema: https://framework.regen.network/schema/ rank: 1000 permissible_values: - conservation: - text: conservation - description: a conservation activity - meaning: rfs:Conservation - ecosystemRestoration: - text: ecosystemRestoration - description: an ecosystem restoration activity - meaning: rfs:EcosystemRestoration + ResidueTillageManagement: + text: ResidueTillageManagement + meaning: rft:ResidueTillageManagement + title: ResidueTillageManagement + BiocharProduction: + text: BiocharProduction + meaning: rft:BiocharProduction + title: BiocharProduction + ImprovedForestManagement: + text: ImprovedForestManagement + meaning: rft:ImprovedForestManagement + title: ImprovedForestManagement + Agroforestry: + text: Agroforestry + meaning: rft:Agroforestry + title: Agroforestry + PrescribedGrazing: + text: PrescribedGrazing + meaning: rft:PrescribedGrazing + title: PrescribedGrazing + RiparianForestBuffers: + text: RiparianForestBuffers + meaning: rft:RiparianForestBuffers + title: RiparianForestBuffers + SoilAmendments: + text: SoilAmendments + meaning: rft:SoilAmendments + title: SoilAmendments + Conservation: + text: Conservation + meaning: rft:Conservation + title: Conservation + Ecotourism: + text: Ecotourism + meaning: rft:Ecotourism + title: Ecotourism + CoverCropping: + text: CoverCropping + meaning: rft:CoverCropping + title: CoverCropping + TreePlanting: + text: TreePlanting + meaning: rft:TreePlanting + title: TreePlanting + PhotocatalystApplication: + text: PhotocatalystApplication + meaning: rft:PhotocatalystApplication + title: PhotocatalystApplication + EcosystemRestoration: + text: EcosystemRestoration + meaning: rft:EcosystemRestoration + title: EcosystemRestoration + IndustrialBiocharProduction: + text: IndustrialBiocharProduction + meaning: rft:IndustrialBiocharProduction + title: IndustrialBiocharProduction + ArtisanalBiocharProduction: + text: ArtisanalBiocharProduction + meaning: rft:ArtisanalBiocharProduction + title: ArtisanalBiocharProduction + Biochar: + text: Biochar + meaning: rft:Biochar + title: Biochar + EnhancedRockWeathering: + text: EnhancedRockWeathering + meaning: rft:EnhancedRockWeathering + title: EnhancedRockWeathering + CompostAmendments: + text: CompostAmendments + meaning: rft:CompostAmendments + title: CompostAmendments + KeystoneSpeciesConservation: + text: KeystoneSpeciesConservation + meaning: rft:KeystoneSpeciesConservation + title: KeystoneSpeciesConservation + UmbrellaSpeciesConservation: + text: UmbrellaSpeciesConservation + meaning: rft:UmbrellaSpeciesConservation + title: UmbrellaSpeciesConservation + Silvopasture: + text: Silvopasture + meaning: rft:Silvopasture + title: Silvopasture + ForestFarming: + text: ForestFarming + meaning: rft:ForestFarming + title: ForestFarming + NonUrbanForestImprovement: + text: NonUrbanForestImprovement + meaning: rft:NonUrbanForestImprovement + title: NonUrbanForestImprovement + UrbanForestImprovement: + text: UrbanForestImprovement + meaning: rft:UrbanForestImprovement + title: UrbanForestImprovement + Afforestation: + text: Afforestation + meaning: rft:Afforestation + title: Afforestation + Reforestation: + text: Reforestation + meaning: rft:Reforestation + title: Reforestation ```
diff --git a/schema/generated/AdministrativeArea.md b/schema/generated/AdministrativeArea.md index 5fd872b..06936e9 100644 --- a/schema/generated/AdministrativeArea.md +++ b/schema/generated/AdministrativeArea.md @@ -1,39 +1,46 @@ -# Slot: administrativeArea +# Class: AdministrativeArea -_The administrative area associated with the project._ +URI: [schema:AdministrativeArea](http://schema.org/AdministrativeArea) +```mermaid +erDiagram +AdministrativeArea { + string name + string url +} -URI: [rfs:administrativeArea](https://framework.regen.network/schema/administrativeArea) - - - +``` + -## Applicable Classes -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [Project](Project.md) | | no | +## Slots +| Name | Cardinality and Range | Description | Inheritance | +| --- | --- | --- | --- | +| [name](name.md) | 1
[String](String.md) | Name of the project | direct | +| [url](url.md) | 0..1
[String](String.md) | | direct | +## Usages -## Properties +| used by | used in | type | used | +| --- | --- | --- | --- | +| [Project](Project.md) | [administrativeArea](administrativeArea.md) | range | [AdministrativeArea](AdministrativeArea.md) | -* Range: [AdministrativeArea](AdministrativeArea.md) @@ -59,24 +66,68 @@ URI: [rfs:administrativeArea](https://framework.regen.network/schema/administrat | Mapping Type | Mapped Value | | --- | --- | -| self | rfs:administrativeArea | -| native | rfs:administrativeArea | +| self | schema:AdministrativeArea | +| native | rfs:AdministrativeArea | + + + ## LinkML Source + + +### Direct + +
+```yaml +name: AdministrativeArea +from_schema: https://framework.regen.network/schema/ +slots: +- name +- url +class_uri: schema:AdministrativeArea + +``` +
+ +### Induced +
```yaml -name: administrativeArea -description: The administrative area associated with the project. +name: AdministrativeArea from_schema: https://framework.regen.network/schema/ -rank: 1000 -alias: administrativeArea -domain_of: -- Project -range: AdministrativeArea +attributes: + name: + name: name + description: Name of the project. + from_schema: https://framework.regen.network/schema/ + rank: 1000 + slot_uri: schema:name + alias: name + owner: AdministrativeArea + domain_of: + - Project + - ProjectRole + - Organization + - AdministrativeArea + - File + range: string + required: true + url: + name: url + from_schema: https://framework.regen.network/schema/ + rank: 1000 + alias: url + owner: AdministrativeArea + domain_of: + - ProjectRole + - Organization + - AdministrativeArea + range: string +class_uri: schema:AdministrativeArea ```
\ No newline at end of file diff --git a/schema/generated/EnvironmentTypeTypes.md b/schema/generated/EnvironmentTypeTypes.md index b8c078c..0a272c1 100644 --- a/schema/generated/EnvironmentTypeTypes.md +++ b/schema/generated/EnvironmentTypeTypes.md @@ -2,25 +2,47 @@ - -_The type of ecosystem_ - - - URI: [EnvironmentTypeTypes](EnvironmentTypeTypes.md) ## Permissible Values | Value | Meaning | Description | | --- | --- | --- | -| cloudForest | rfs:CloudForest | | -| tropicalSavannah | rfs:TropicalSavannah | | -| tropicalDryForest | rfs:TropicalDryForest | | -| tropicalForest | rfs:TropicalForest | | -| tropicalVeryHumidForest | rfs:TropicalVeryHumidForest | | -| tropicalHumidForest | rfs:TropicalHumidForest | | -| premontaneHumidForest | rfs:PremontaneHumidForest | | -| lowMontaneVeryHumidForest | rfs:LowMontaneVeryHumidForest | | +| Marine | rft:Marine | | +| Cropland | rft:Cropland | | +| UrbanTrees | rft:UrbanTrees | | +| Shrubland | rft:Shrubland | | +| Pasture | rft:Pasture | | +| Savanna | rft:Savanna | | +| Grassland | rft:Grassland | | +| AgroforestrySystem | rft:AgroforestrySystem | | +| PermanentIce | rft:PermanentIce | | +| Wetland | rft:Wetland | | +| Freshwater | rft:Freshwater | | +| Orchard | rft:Orchard | | +| AquacultureSystem | rft:AquacultureSystem | | +| Vineyard | rft:Vineyard | | +| Desert | rft:Desert | | +| Forest | rft:Forest | | +| IrrigatedCropland | rft:IrrigatedCropland | | +| RainfedCropland | rft:RainfedCropland | | +| TemperateShrubland | rft:TemperateShrubland | | +| BorealShrubland | rft:BorealShrubland | | +| TropicalShrubland | rft:TropicalShrubland | | +| Marsh | rft:Marsh | | +| Bog | rft:Bog | | +| Swamp | rft:Swamp | | +| TropicalForest | rft:TropicalForest | | +| TemperateForest | rft:TemperateForest | | +| BorealForest | rft:BorealForest | | +| Coastal | rft:Coastal | | +| DeepWater | rft:DeepWater | | +| CoralReef | rft:CoralReef | | +| TemperateGrassland | rft:TemperateGrassland | | +| Tundra | rft:Tundra | | +| TropicalGrassland | rft:TropicalGrassland | | +| Lake | rft:Lake | | +| Watercourse | rft:Watercourse | | @@ -29,7 +51,7 @@ URI: [EnvironmentTypeTypes](EnvironmentTypeTypes.md) | Name | Description | | --- | --- | -| [environmentType](environmentType.md) | The type of environment associated with the project | +| [environmentType](environmentType.md) | General classification of the project's environment type | @@ -59,34 +81,149 @@ URI: [EnvironmentTypeTypes](EnvironmentTypeTypes.md)
```yaml name: EnvironmentTypeTypes -description: The type of ecosystem from_schema: https://framework.regen.network/schema/ rank: 1000 permissible_values: - cloudForest: - text: cloudForest - meaning: rfs:CloudForest - tropicalSavannah: - text: tropicalSavannah - meaning: rfs:TropicalSavannah - tropicalDryForest: - text: tropicalDryForest - meaning: rfs:TropicalDryForest - tropicalForest: - text: tropicalForest - meaning: rfs:TropicalForest - tropicalVeryHumidForest: - text: tropicalVeryHumidForest - meaning: rfs:TropicalVeryHumidForest - tropicalHumidForest: - text: tropicalHumidForest - meaning: rfs:TropicalHumidForest - premontaneHumidForest: - text: premontaneHumidForest - meaning: rfs:PremontaneHumidForest - lowMontaneVeryHumidForest: - text: lowMontaneVeryHumidForest - meaning: rfs:LowMontaneVeryHumidForest + Marine: + text: Marine + meaning: rft:Marine + title: Marine + Cropland: + text: Cropland + meaning: rft:Cropland + title: Cropland + UrbanTrees: + text: UrbanTrees + meaning: rft:UrbanTrees + title: UrbanTrees + Shrubland: + text: Shrubland + meaning: rft:Shrubland + title: Shrubland + Pasture: + text: Pasture + meaning: rft:Pasture + title: Pasture + Savanna: + text: Savanna + meaning: rft:Savanna + title: Savanna + Grassland: + text: Grassland + meaning: rft:Grassland + title: Grassland + AgroforestrySystem: + text: AgroforestrySystem + meaning: rft:AgroforestrySystem + title: AgroforestrySystem + PermanentIce: + text: PermanentIce + meaning: rft:PermanentIce + title: PermanentIce + Wetland: + text: Wetland + meaning: rft:Wetland + title: Wetland + Freshwater: + text: Freshwater + meaning: rft:Freshwater + title: Freshwater + Orchard: + text: Orchard + meaning: rft:Orchard + title: Orchard + AquacultureSystem: + text: AquacultureSystem + meaning: rft:AquacultureSystem + title: AquacultureSystem + Vineyard: + text: Vineyard + meaning: rft:Vineyard + title: Vineyard + Desert: + text: Desert + meaning: rft:Desert + title: Desert + Forest: + text: Forest + meaning: rft:Forest + title: Forest + IrrigatedCropland: + text: IrrigatedCropland + meaning: rft:IrrigatedCropland + title: IrrigatedCropland + RainfedCropland: + text: RainfedCropland + meaning: rft:RainfedCropland + title: RainfedCropland + TemperateShrubland: + text: TemperateShrubland + meaning: rft:TemperateShrubland + title: TemperateShrubland + BorealShrubland: + text: BorealShrubland + meaning: rft:BorealShrubland + title: BorealShrubland + TropicalShrubland: + text: TropicalShrubland + meaning: rft:TropicalShrubland + title: TropicalShrubland + Marsh: + text: Marsh + meaning: rft:Marsh + title: Marsh + Bog: + text: Bog + meaning: rft:Bog + title: Bog + Swamp: + text: Swamp + meaning: rft:Swamp + title: Swamp + TropicalForest: + text: TropicalForest + meaning: rft:TropicalForest + title: TropicalForest + TemperateForest: + text: TemperateForest + meaning: rft:TemperateForest + title: TemperateForest + BorealForest: + text: BorealForest + meaning: rft:BorealForest + title: BorealForest + Coastal: + text: Coastal + meaning: rft:Coastal + title: Coastal + DeepWater: + text: DeepWater + meaning: rft:DeepWater + title: DeepWater + CoralReef: + text: CoralReef + meaning: rft:CoralReef + title: CoralReef + TemperateGrassland: + text: TemperateGrassland + meaning: rft:TemperateGrassland + title: TemperateGrassland + Tundra: + text: Tundra + meaning: rft:Tundra + title: Tundra + TropicalGrassland: + text: TropicalGrassland + meaning: rft:TropicalGrassland + title: TropicalGrassland + Lake: + text: Lake + meaning: rft:Lake + title: Lake + Watercourse: + text: Watercourse + meaning: rft:Watercourse + title: Watercourse ```
diff --git a/schema/generated/ImpactTypes.md b/schema/generated/ImpactTypes.md new file mode 100644 index 0000000..1d63723 --- /dev/null +++ b/schema/generated/ImpactTypes.md @@ -0,0 +1,149 @@ +# Enum: ImpactTypes + + + +URI: [ImpactTypes](ImpactTypes.md) + +## Permissible Values + +| Value | Meaning | Description | +| --- | --- | --- | +| ReducedFertilizerAmendments | rft:ReducedFertilizerAmendments | | +| AvoidedDeforestationDegradation | rft:AvoidedDeforestationDegradation | | +| ImprovedCulturalHeritageAwareness | rft:ImprovedCulturalHeritageAwareness | | +| ImprovedBiodiversity | rft:ImprovedBiodiversity | | +| ImprovedEnvironmentalEducationOutreach | rft:ImprovedEnvironmentalEducationOutreach | | +| ReducedSoilErosion | rft:ReducedSoilErosion | | +| ReducedHerbicideAmendments | rft:ReducedHerbicideAmendments | | +| ImprovedForestHealth | rft:ImprovedForestHealth | | +| ImprovedCommunityHealth | rft:ImprovedCommunityHealth | | +| ImprovedWildlifeHabitat | rft:ImprovedWildlifeHabitat | | +| ImprovedSoilHealth | rft:ImprovedSoilHealth | | +| IncreasedForestCover | rft:IncreasedForestCover | | +| ReducedPesticideAmendments | rft:ReducedPesticideAmendments | | +| ImprovedWaterInfiltration | rft:ImprovedWaterInfiltration | | +| ImprovedWaterHoldingCapacity | rft:ImprovedWaterHoldingCapacity | | +| IncreasedCarbonSequestrationStorage | rft:IncreasedCarbonSequestrationStorage | | +| ReducedIrrigation | rft:ReducedIrrigation | | +| ImprovedSoilStructure | rft:ImprovedSoilStructure | | +| ImprovedNutrientCycling | rft:ImprovedNutrientCycling | | + + + + +## Slots + +| Name | Description | +| --- | --- | +| [impact](impact.md) | A project or initiative’s current and potential impact | + + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: https://framework.regen.network/schema/ + + + + + + +## LinkML Source + +
+```yaml +name: ImpactTypes +from_schema: https://framework.regen.network/schema/ +rank: 1000 +permissible_values: + ReducedFertilizerAmendments: + text: ReducedFertilizerAmendments + meaning: rft:ReducedFertilizerAmendments + title: ReducedFertilizerAmendments + AvoidedDeforestationDegradation: + text: AvoidedDeforestationDegradation + meaning: rft:AvoidedDeforestationDegradation + title: AvoidedDeforestationDegradation + ImprovedCulturalHeritageAwareness: + text: ImprovedCulturalHeritageAwareness + meaning: rft:ImprovedCulturalHeritageAwareness + title: ImprovedCulturalHeritageAwareness + ImprovedBiodiversity: + text: ImprovedBiodiversity + meaning: rft:ImprovedBiodiversity + title: ImprovedBiodiversity + ImprovedEnvironmentalEducationOutreach: + text: ImprovedEnvironmentalEducationOutreach + meaning: rft:ImprovedEnvironmentalEducationOutreach + title: ImprovedEnvironmentalEducationOutreach + ReducedSoilErosion: + text: ReducedSoilErosion + meaning: rft:ReducedSoilErosion + title: ReducedSoilErosion + ReducedHerbicideAmendments: + text: ReducedHerbicideAmendments + meaning: rft:ReducedHerbicideAmendments + title: ReducedHerbicideAmendments + ImprovedForestHealth: + text: ImprovedForestHealth + meaning: rft:ImprovedForestHealth + title: ImprovedForestHealth + ImprovedCommunityHealth: + text: ImprovedCommunityHealth + meaning: rft:ImprovedCommunityHealth + title: ImprovedCommunityHealth + ImprovedWildlifeHabitat: + text: ImprovedWildlifeHabitat + meaning: rft:ImprovedWildlifeHabitat + title: ImprovedWildlifeHabitat + ImprovedSoilHealth: + text: ImprovedSoilHealth + meaning: rft:ImprovedSoilHealth + title: ImprovedSoilHealth + IncreasedForestCover: + text: IncreasedForestCover + meaning: rft:IncreasedForestCover + title: IncreasedForestCover + ReducedPesticideAmendments: + text: ReducedPesticideAmendments + meaning: rft:ReducedPesticideAmendments + title: ReducedPesticideAmendments + ImprovedWaterInfiltration: + text: ImprovedWaterInfiltration + meaning: rft:ImprovedWaterInfiltration + title: ImprovedWaterInfiltration + ImprovedWaterHoldingCapacity: + text: ImprovedWaterHoldingCapacity + meaning: rft:ImprovedWaterHoldingCapacity + title: ImprovedWaterHoldingCapacity + IncreasedCarbonSequestrationStorage: + text: IncreasedCarbonSequestrationStorage + meaning: rft:IncreasedCarbonSequestrationStorage + title: IncreasedCarbonSequestrationStorage + ReducedIrrigation: + text: ReducedIrrigation + meaning: rft:ReducedIrrigation + title: ReducedIrrigation + ImprovedSoilStructure: + text: ImprovedSoilStructure + meaning: rft:ImprovedSoilStructure + title: ImprovedSoilStructure + ImprovedNutrientCycling: + text: ImprovedNutrientCycling + meaning: rft:ImprovedNutrientCycling + title: ImprovedNutrientCycling + +``` +
diff --git a/schema/generated/ManagementArea.md b/schema/generated/ManagementArea.md index fda41b3..082e8c1 100644 --- a/schema/generated/ManagementArea.md +++ b/schema/generated/ManagementArea.md @@ -31,7 +31,7 @@ ManagementArea ||--|o QuantityValue : "extent" | Name | Cardinality and Range | Description | Inheritance | | --- | --- | --- | --- | -| [activity](activity.md) | *
[ActivityTypes](ActivityTypes.md) | the activity | direct | +| [activity](activity.md) | *
[ActivityTypes](ActivityTypes.md) | The types of activities being implemented in projects | direct | | [extent](extent.md) | 0..1
[QuantityValue](QuantityValue.md) | the extent | direct | @@ -105,7 +105,7 @@ from_schema: https://framework.regen.network/schema/ attributes: activity: name: activity - description: the activity. + description: The types of activities being implemented in projects from_schema: https://framework.regen.network/schema/ rank: 1000 slot_uri: rfs:activity diff --git a/schema/generated/OffchainCreditsInfo.md b/schema/generated/OffchainCreditsInfo.md index b3a2e24..cc3a2c6 100644 --- a/schema/generated/OffchainCreditsInfo.md +++ b/schema/generated/OffchainCreditsInfo.md @@ -1,39 +1,52 @@ -# Slot: offchainCreditsInfo +# Class: OffchainCreditsInfo -_Information about offchain credits associated with the project._ +URI: [rfs:OffchainCreditsInfo](https://framework.regen.network/schema/OffchainCreditsInfo) +```mermaid +erDiagram +OffchainCreditsInfo { -URI: [rfs:offchainCreditsInfo](https://framework.regen.network/schema/offchainCreditsInfo) +} +QuantityValue { + float numericValue + string unit +} +OffchainCreditsInfo ||--|o QuantityValue : "creditsRegistered" +OffchainCreditsInfo ||--|o QuantityValue : "creditsAvailable" +OffchainCreditsInfo ||--|o QuantityValue : "creditsRetired" - - - +``` + -## Applicable Classes -| Name | Description | Modifies Slot | -| --- | --- | --- | -| [Project](Project.md) | | no | +## Slots +| Name | Cardinality and Range | Description | Inheritance | +| --- | --- | --- | --- | +| [creditsRegistered](creditsRegistered.md) | 0..1
[QuantityValue](QuantityValue.md) | The number of credits registered | direct | +| [creditsAvailable](creditsAvailable.md) | 0..1
[QuantityValue](QuantityValue.md) | The number of credits available | direct | +| [creditsRetired](creditsRetired.md) | 0..1
[QuantityValue](QuantityValue.md) | The number of credits retired | direct | +## Usages -## Properties +| used by | used in | type | used | +| --- | --- | --- | --- | +| [Project](Project.md) | [offchainCreditsInfo](offchainCreditsInfo.md) | range | [OffchainCreditsInfo](OffchainCreditsInfo.md) | -* Range: [OffchainCreditsInfo](OffchainCreditsInfo.md) @@ -59,25 +72,93 @@ URI: [rfs:offchainCreditsInfo](https://framework.regen.network/schema/offchainCr | Mapping Type | Mapped Value | | --- | --- | -| self | rfs:offchainCreditsInfo | -| native | rfs:offchainCreditsInfo | +| self | rfs:OffchainCreditsInfo | +| native | rfs:OffchainCreditsInfo | + + + ## LinkML Source + + +### Direct + +
+```yaml +name: OffchainCreditsInfo +from_schema: https://framework.regen.network/schema/ +attributes: + creditsRegistered: + name: creditsRegistered + description: The number of credits registered + from_schema: https://framework.regen.network/schema/ + rank: 1000 + domain_of: + - OffchainCreditsInfo + range: QuantityValue + creditsAvailable: + name: creditsAvailable + description: The number of credits available + from_schema: https://framework.regen.network/schema/ + rank: 1000 + domain_of: + - OffchainCreditsInfo + range: QuantityValue + creditsRetired: + name: creditsRetired + description: The number of credits retired + from_schema: https://framework.regen.network/schema/ + rank: 1000 + domain_of: + - OffchainCreditsInfo + range: QuantityValue +class_uri: rfs:OffchainCreditsInfo + +``` +
+ +### Induced +
```yaml -name: offchainCreditsInfo -description: Information about offchain credits associated with the project. +name: OffchainCreditsInfo from_schema: https://framework.regen.network/schema/ -rank: 1000 -slot_uri: rfs:offchainCreditsInfo -alias: offchainCreditsInfo -domain_of: -- Project -range: OffchainCreditsInfo +attributes: + creditsRegistered: + name: creditsRegistered + description: The number of credits registered + from_schema: https://framework.regen.network/schema/ + rank: 1000 + alias: creditsRegistered + owner: OffchainCreditsInfo + domain_of: + - OffchainCreditsInfo + range: QuantityValue + creditsAvailable: + name: creditsAvailable + description: The number of credits available + from_schema: https://framework.regen.network/schema/ + rank: 1000 + alias: creditsAvailable + owner: OffchainCreditsInfo + domain_of: + - OffchainCreditsInfo + range: QuantityValue + creditsRetired: + name: creditsRetired + description: The number of credits retired + from_schema: https://framework.regen.network/schema/ + rank: 1000 + alias: creditsRetired + owner: OffchainCreditsInfo + domain_of: + - OffchainCreditsInfo + range: QuantityValue +class_uri: rfs:OffchainCreditsInfo ```
\ No newline at end of file diff --git a/schema/generated/Project.md b/schema/generated/Project.md index 86a1631..1b08c4c 100644 --- a/schema/generated/Project.md +++ b/schema/generated/Project.md @@ -19,13 +19,14 @@ Project { string biomeType string watershed string subWatershed - EnvironmentTypeTypesList environmentType string projectDuration float ecologicalConnectivityIndex float socialCulturalIndex string creditClassVersion + ActivityTypesList activity + EnvironmentTypeTypesList environmentType + ImpactTypesList impact integer size - string activity string start_date string end_date string project_type @@ -103,7 +104,6 @@ OffchainCreditsInfo ||--|o QuantityValue : "creditsRetired" | [biomeType](biomeType.md) | 0..1
[String](String.md) | The type of biome associated with the project | direct | | [watershed](watershed.md) | 0..1
[String](String.md) | The watershed associated with the project | direct | | [subWatershed](subWatershed.md) | 0..1
[String](String.md) | The sub-watershed associated with the project | direct | -| [environmentType](environmentType.md) | *
[EnvironmentTypeTypes](EnvironmentTypeTypes.md) | The type of environment associated with the project | direct | | [offchainCreditsInfo](offchainCreditsInfo.md) | 0..1
[OffchainCreditsInfo](OffchainCreditsInfo.md) | Information about offchain credits associated with the project | direct | | [projectDuration](projectDuration.md) | 0..1
[String](String.md) | The duration of the project | direct | | [managementAreas](managementAreas.md) | *
[ManagementArea](ManagementArea.md) | The management areas associated with the project | direct | @@ -116,8 +116,10 @@ OffchainCreditsInfo ||--|o QuantityValue : "creditsRetired" | [projectVerifier](projectVerifier.md) | 0..1
[Organization](Organization.md) | The organization responsible for owning the project | direct | | [projectDeveloper](projectDeveloper.md) | 0..1
[Organization](Organization.md) | The organization responsible for owning the project | direct | | [creditClassVersion](creditClassVersion.md) | 0..1
[String](String.md) | The version of the credit class used for the project | direct | +| [activity](activity.md) | *
[ActivityTypes](ActivityTypes.md) | The types of activities being implemented in projects | direct | +| [environmentType](environmentType.md) | *
[EnvironmentTypeTypes](EnvironmentTypeTypes.md) | General classification of the project's environment type | direct | +| [impact](impact.md) | *
[ImpactTypes](ImpactTypes.md) | A project or initiative’s current and potential impact | direct | | [size](size.md) | 0..1
[Integer](Integer.md) | | direct | -| [activity](activity.md) | 0..1
[String](String.md) | | direct | | [start_date](start_date.md) | 0..1
[String](String.md) | | direct | | [end_date](end_date.md) | 0..1
[String](String.md) | | direct | | [project_type](project_type.md) | 0..1
[String](String.md) | | direct | @@ -182,7 +184,6 @@ slots: - biomeType - watershed - subWatershed -- environmentType - offchainCreditsInfo - projectDuration - managementAreas @@ -195,6 +196,9 @@ slots: - projectVerifier - projectDeveloper - creditClassVersion +- activity +- environmentType +- impact attributes: size: name: size @@ -203,12 +207,6 @@ attributes: domain_of: - Project range: integer - activity: - name: activity - from_schema: https://framework.regen.network/schema/ - domain_of: - - Project - - ManagementArea start_date: name: start_date from_schema: https://framework.regen.network/schema/ @@ -254,15 +252,6 @@ attributes: domain_of: - Project range: integer - activity: - name: activity - from_schema: https://framework.regen.network/schema/ - alias: activity - owner: Project - domain_of: - - Project - - ManagementArea - range: string start_date: name: start_date from_schema: https://framework.regen.network/schema/ @@ -426,18 +415,6 @@ attributes: domain_of: - Project range: string - environmentType: - name: environmentType - description: The type of environment associated with the project. - from_schema: https://framework.regen.network/schema/ - rank: 1000 - slot_uri: rfs:environmentType - alias: environmentType - owner: Project - domain_of: - - Project - range: EnvironmentTypeTypes - multivalued: true offchainCreditsInfo: name: offchainCreditsInfo description: Information about offchain credits associated with the project. @@ -571,6 +548,43 @@ attributes: domain_of: - Project range: string + activity: + name: activity + description: The types of activities being implemented in projects + from_schema: https://framework.regen.network/schema/ + rank: 1000 + slot_uri: rfs:activity + alias: activity + owner: Project + domain_of: + - Project + - ManagementArea + range: ActivityTypes + multivalued: true + environmentType: + name: environmentType + description: General classification of the project's environment type. + from_schema: https://framework.regen.network/schema/ + rank: 1000 + slot_uri: rfs:environmentType + alias: environmentType + owner: Project + domain_of: + - Project + range: EnvironmentTypeTypes + multivalued: true + impact: + name: impact + description: A project or initiative’s current and potential impact + from_schema: https://framework.regen.network/schema/ + rank: 1000 + slot_uri: rfs:impact + alias: impact + owner: Project + domain_of: + - Project + range: ImpactTypes + multivalued: true class_uri: rfs:Project ``` diff --git a/schema/generated/activity.md b/schema/generated/activity.md index 48b44eb..1cf3b26 100644 --- a/schema/generated/activity.md +++ b/schema/generated/activity.md @@ -3,7 +3,7 @@ # Slot: activity -_the activity._ +_The types of activities being implemented in projects_ @@ -23,8 +23,8 @@ URI: [rfs:activity](https://framework.regen.network/schema/activity) | Name | Description | Modifies Slot | | --- | --- | --- | -| [Project](Project.md) | | no | | [ManagementArea](ManagementArea.md) | | no | +| [Project](Project.md) | | no | @@ -73,7 +73,7 @@ URI: [rfs:activity](https://framework.regen.network/schema/activity)
```yaml name: activity -description: the activity. +description: The types of activities being implemented in projects from_schema: https://framework.regen.network/schema/ rank: 1000 slot_uri: rfs:activity diff --git a/schema/generated/administrativeArea.md b/schema/generated/administrativeArea.md new file mode 100644 index 0000000..5fd872b --- /dev/null +++ b/schema/generated/administrativeArea.md @@ -0,0 +1,82 @@ + + +# Slot: administrativeArea + + +_The administrative area associated with the project._ + + + + + +URI: [rfs:administrativeArea](https://framework.regen.network/schema/administrativeArea) + + + + + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [Project](Project.md) | | no | + + + + + + + +## Properties + +* Range: [AdministrativeArea](AdministrativeArea.md) + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: https://framework.regen.network/schema/ + + + + +## Mappings + +| Mapping Type | Mapped Value | +| --- | --- | +| self | rfs:administrativeArea | +| native | rfs:administrativeArea | + + + + +## LinkML Source + +
+```yaml +name: administrativeArea +description: The administrative area associated with the project. +from_schema: https://framework.regen.network/schema/ +rank: 1000 +alias: administrativeArea +domain_of: +- Project +range: AdministrativeArea + +``` +
\ No newline at end of file diff --git a/schema/generated/description.md b/schema/generated/description.md index 7f3c408..aa990b0 100644 --- a/schema/generated/description.md +++ b/schema/generated/description.md @@ -23,10 +23,10 @@ URI: [schema:description](http://schema.org/description) | Name | Description | Modifies Slot | | --- | --- | --- | -| [Project](Project.md) | | no | +| [ProjectRole](ProjectRole.md) | | no | | [Organization](Organization.md) | | no | | [File](File.md) | | no | -| [ProjectRole](ProjectRole.md) | | no | +| [Project](Project.md) | | no | diff --git a/schema/generated/environmentType.md b/schema/generated/environmentType.md index c0dc9bf..e54a3df 100644 --- a/schema/generated/environmentType.md +++ b/schema/generated/environmentType.md @@ -3,7 +3,7 @@ # Slot: environmentType -_The type of environment associated with the project._ +_General classification of the project's environment type._ @@ -72,7 +72,7 @@ URI: [rfs:environmentType](https://framework.regen.network/schema/environmentTyp
```yaml name: environmentType -description: The type of environment associated with the project. +description: General classification of the project's environment type. from_schema: https://framework.regen.network/schema/ rank: 1000 slot_uri: rfs:environmentType diff --git a/schema/generated/image.md b/schema/generated/image.md index 1a1f6a5..085c704 100644 --- a/schema/generated/image.md +++ b/schema/generated/image.md @@ -23,8 +23,8 @@ URI: [schema:image](http://schema.org/image) | Name | Description | Modifies Slot | | --- | --- | --- | -| [Organization](Organization.md) | | no | | [ProjectRole](ProjectRole.md) | | no | +| [Organization](Organization.md) | | no | diff --git a/schema/generated/impact.md b/schema/generated/impact.md new file mode 100644 index 0000000..ad64e0f --- /dev/null +++ b/schema/generated/impact.md @@ -0,0 +1,86 @@ + + +# Slot: impact + + +_A project or initiative’s current and potential impact_ + + + + + +URI: [rfs:impact](https://framework.regen.network/schema/impact) + + + + + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [Project](Project.md) | | no | + + + + + + + +## Properties + +* Range: [ImpactTypes](ImpactTypes.md) + +* Multivalued: True + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: https://framework.regen.network/schema/ + + + + +## Mappings + +| Mapping Type | Mapped Value | +| --- | --- | +| self | rfs:impact | +| native | rfs:impact | + + + + +## LinkML Source + +
+```yaml +name: impact +description: A project or initiative’s current and potential impact +from_schema: https://framework.regen.network/schema/ +rank: 1000 +slot_uri: rfs:impact +alias: impact +domain_of: +- Project +range: ImpactTypes +multivalued: true + +``` +
\ No newline at end of file diff --git a/schema/generated/index.md b/schema/generated/index.md index 8c51317..7aac93f 100644 --- a/schema/generated/index.md +++ b/schema/generated/index.md @@ -30,7 +30,7 @@ Name: Schemas | Slot | Description | | --- | --- | -| [activity](activity.md) | the activity | +| [activity](activity.md) | The types of activities being implemented in projects | | [address](address.md) | an address | | [administrativeArea](administrativeArea.md) | The administrative area associated with the project | | [biomeType](biomeType.md) | The type of biome associated with the project | @@ -45,11 +45,12 @@ Name: Schemas | [ecologicalConnectivityIndex](ecologicalConnectivityIndex.md) | The ecological connectivity index of the project | | [end_date](end_date.md) | | | [environmentalAuthority](environmentalAuthority.md) | The environmental authority associated with the project | -| [environmentType](environmentType.md) | The type of environment associated with the project | +| [environmentType](environmentType.md) | General classification of the project's environment type | | [extent](extent.md) | the extent | | [files](files.md) | | | [id](id.md) | | | [image](image.md) | an image | +| [impact](impact.md) | A project or initiative’s current and potential impact | | [iri](iri.md) | | | [location](location.md) | | | [managementAreas](managementAreas.md) | The management areas associated with the project | @@ -84,8 +85,9 @@ Name: Schemas | Enumeration | Description | | --- | --- | -| [ActivityTypes](ActivityTypes.md) | The type of activity | -| [EnvironmentTypeTypes](EnvironmentTypeTypes.md) | The type of ecosystem | +| [ActivityTypes](ActivityTypes.md) | | +| [EnvironmentTypeTypes](EnvironmentTypeTypes.md) | | +| [ImpactTypes](ImpactTypes.md) | | | [MarketTypeTypes](MarketTypeTypes.md) | The type of marketplace | | [ProjectRoleTypes](ProjectRoleTypes.md) | | diff --git a/schema/generated/name.md b/schema/generated/name.md index 00e0449..effb499 100644 --- a/schema/generated/name.md +++ b/schema/generated/name.md @@ -23,11 +23,11 @@ URI: [schema:name](http://schema.org/name) | Name | Description | Modifies Slot | | --- | --- | --- | -| [Organization](Organization.md) | | no | +| [ProjectRole](ProjectRole.md) | | no | | [File](File.md) | | no | | [AdministrativeArea](AdministrativeArea.md) | | no | | [Project](Project.md) | | no | -| [ProjectRole](ProjectRole.md) | | no | +| [Organization](Organization.md) | | no | diff --git a/schema/generated/offchainCreditsInfo.md b/schema/generated/offchainCreditsInfo.md new file mode 100644 index 0000000..b3a2e24 --- /dev/null +++ b/schema/generated/offchainCreditsInfo.md @@ -0,0 +1,83 @@ + + +# Slot: offchainCreditsInfo + + +_Information about offchain credits associated with the project._ + + + + + +URI: [rfs:offchainCreditsInfo](https://framework.regen.network/schema/offchainCreditsInfo) + + + + + + + + + +## Applicable Classes + +| Name | Description | Modifies Slot | +| --- | --- | --- | +| [Project](Project.md) | | no | + + + + + + + +## Properties + +* Range: [OffchainCreditsInfo](OffchainCreditsInfo.md) + + + + + +## Identifier and Mapping Information + + + + + + + +### Schema Source + + +* from schema: https://framework.regen.network/schema/ + + + + +## Mappings + +| Mapping Type | Mapped Value | +| --- | --- | +| self | rfs:offchainCreditsInfo | +| native | rfs:offchainCreditsInfo | + + + + +## LinkML Source + +
+```yaml +name: offchainCreditsInfo +description: Information about offchain credits associated with the project. +from_schema: https://framework.regen.network/schema/ +rank: 1000 +slot_uri: rfs:offchainCreditsInfo +alias: offchainCreditsInfo +domain_of: +- Project +range: OffchainCreditsInfo + +``` +
\ No newline at end of file diff --git a/schema/generated/url.md b/schema/generated/url.md index fc5981e..e9b6d70 100644 --- a/schema/generated/url.md +++ b/schema/generated/url.md @@ -19,8 +19,8 @@ URI: [rfs:url](https://framework.regen.network/schema/url) | Name | Description | Modifies Slot | | --- | --- | --- | | [AdministrativeArea](AdministrativeArea.md) | | no | -| [Organization](Organization.md) | | no | | [ProjectRole](ProjectRole.md) | | no | +| [Organization](Organization.md) | | no | From 1d1eac967c757d4050c88736671b2b09da8c7eb3 Mon Sep 17 00:00:00 2001 From: Paul Weidner Date: Thu, 3 Oct 2024 11:30:45 -0700 Subject: [PATCH 5/5] Add example project data --- schema/README.md | 2 +- .../Project-Terassos.jsonld} | 0 .../Project-Terassos.yaml} | 0 schema/generated/Project.md | 67 +++++++++++++++++++ 4 files changed, 68 insertions(+), 1 deletion(-) rename schema/{data/project-data.jsonld => examples/Project-Terassos.jsonld} (100%) rename schema/{data/project-data.yaml => examples/Project-Terassos.yaml} (100%) diff --git a/schema/README.md b/schema/README.md index 41df871..6cd085c 100644 --- a/schema/README.md +++ b/schema/README.md @@ -12,7 +12,7 @@ - Create separate schema files for each logical schema class and `import` into the root `schemas.yaml` file. - Generated markdown from schemas: ```shell - gen-doc schema/src/schemas.yaml --directory schema/generated --diagram-type er_diagram + gen-doc schema/src/schemas.yaml --directory schema/generated --example-directory schema/examples --diagram-type er_diagram ``` - Generate linkml enums for taxonomy terms: ```shell diff --git a/schema/data/project-data.jsonld b/schema/examples/Project-Terassos.jsonld similarity index 100% rename from schema/data/project-data.jsonld rename to schema/examples/Project-Terassos.jsonld diff --git a/schema/data/project-data.yaml b/schema/examples/Project-Terassos.yaml similarity index 100% rename from schema/data/project-data.yaml rename to schema/examples/Project-Terassos.yaml diff --git a/schema/generated/Project.md b/schema/generated/Project.md index 1b08c4c..48af9d1 100644 --- a/schema/generated/Project.md +++ b/schema/generated/Project.md @@ -159,6 +159,73 @@ OffchainCreditsInfo ||--|o QuantityValue : "creditsRetired" +## Examples +### Example: Project-Terassos + +```yaml + id: "http://dev.app.regen.com/projects/38" + name: "Amazon Rainforest Conservation Project" + marketType: compliance + bioregion: "Amazon Basin" + biomeType: "TropicalForest" + watershed: "Amazon River" + subWatershed: "Upper Amazon" + environmentType: + - cloudForest + offchainCreditsInfo: + creditsRegistered: + numericValue: 1000 + unit: unit:HA + creditsAvailable: + numericValue: 800 + unit: unit:HA + creditsRetired: + numericValue: 200 + unit: unit:HA + projectDuration: "P1Y" + creditClassVersion: "1.0" + ecologicalConnectivityIndex: 75.5 + socialCulturalIndex: 85.0 + environmentalAuthority: + name: "Corantioquia" + url: "http://corantioquia.gov.co/" + administrativeArea: + name: "Antioquia" + managementAreas: + - activity: + - conservation + extent: + numericValue: 120 + unit: unit:HA + - activity: + - ecosystemRestoration + extent: + numericValue: 220 + unit: unit:HA + projectDeveloper: + name: Terrasos + description: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.  + image: https://via.placeholder.com/150 + projectOperator: + name: El Globo + description: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.  + image: https://via.placeholder.com/150 + projectVerifier: + name: KPMG + description: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.  + image: https://via.placeholder.com/150 + projectMonitor: + name: EAFIT + description: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.  + image: https://via.placeholder.com/150 + projectOwner: + name: Jose Gonzales + description: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.  + image: https://via.placeholder.com/150 + + +``` +