WARNING: This site is a work in progress.
Class: CreditClassInfo
Base class with common fields used to define credit class info.
URI: rfs:CreditClassInfo
erDiagram
CreditClassInfo {
string name
string description
string url
duration creditingTerm
stringList eligibleEcosystemTypes
stringList eligibleActivities
string geographicApplicability
}
Methodology {
string name
string url
string version
string identifier
}
CreditProtocol {
string name
string url
string version
string identifier
}
CreditingProgram {
string name
string url
string version
string identifier
}
Registry {
string name
string url
}
Impact {
string name
string id
SDGList hasSDG
}
CreditClassInfo ||--|| Impact : "hasPrimaryImpact"
CreditClassInfo ||--}o Impact : "hasCoBenefits"
CreditClassInfo ||--|o Registry : "sourceRegistry"
CreditClassInfo ||--|o CreditingProgram : "program"
CreditClassInfo ||--|o CreditProtocol : "creditProtocol"
CreditClassInfo ||--}o Methodology : "approvedMethodologies"
Inheritance
- CreditClassInfo
Slots
Name | Cardinality and Range | Description | Inheritance |
---|---|---|---|
name | 1 String | Name of the entity / resource | direct |
description | 0..1 String | Description of the entity / resource | direct |
url | 0..1 String | Link to a valid URL where more information can be found about the entity / re… | direct |
hasPrimaryImpact | 1 Impact | The primary impact expected from adhering to the protocol and/or management p… | direct |
hasCoBenefits | * Impact | Co-benefits are any secondary impacts that may result from adhering to the pr… | direct |
sourceRegistry | 0..1 Registry | The registry where the credits are originally issued and tracked if somewhere… | direct |
program | 0..1 CreditingProgram | The higher-level rules and requirements under which the given credit protocol… | direct |
creditProtocol | 0..1 CreditProtocol | The root document of the credit protocol that defines the requirements and pr… | direct |
approvedMethodologies | * Methodology | If one or more standalone methodologies for quantifying GHG or other benefits… | direct |
creditingTerm | 0..1 Duration | The total duration of the crediting term for the project | direct |
eligibleEcosystemTypes | * String | Types of ecosystems that a project in this credit class may focuses on | direct |
eligibleActivities | * String | Eligible activities for registered projects | direct |
geographicApplicability | 0..1 String | Geographic applicability of the credit class | direct |
TODOs
- What’s the relationship between creditProtocol and approvedMethodologies, in terms of which is required and not? Should one be folded into the other, or atleast align on a single class for the fields’ ranges?
- what’s hte relationship between sourceRegistry and program?
- Should creditProtocol have a field for “program” instead of program living in the CreditClassInfo?
- are the correct slots required?
- is the inheritiance setup with Biodiv & Carbon correct?
- clarificaiton on naming for primaryImpact & coBenefits?
- should fields in general be switched to snake_case, and use verbs like has_, is_, or part_of_? (https://linkml.io/linkml/schemas/linter.html#standard-naming)
Identifier and Mapping Information
Schema Source
- from schema: https://framework.regen.network/schema/
Mappings
Mapping Type | Mapped Value |
---|---|
self | rfs:CreditClassInfo |
native | rfs:CreditClassInfo |
LinkML Source
Direct
```yaml
name: CreditClassInfo
description: Base class with common fields used to define credit class info.
todos:
- What's the relationship between creditProtocol and approvedMethodologies, in terms
of which is required and not? Should one be folded into the other, or atleast align
on a single class for the fields' ranges?
- what's hte relationship between sourceRegistry and program?
- Should creditProtocol have a field for "program" instead of program living in the
CreditClassInfo?
- are the correct slots required?
- is the inheritiance setup with Biodiv & Carbon correct?
- clarificaiton on naming for primaryImpact & coBenefits?
- should fields in general be switched to snake_case, and use verbs like has_, is_,
or part_of_? (https://linkml.io/linkml/schemas/linter.html#standard-naming)
from_schema: https://framework.regen.network/schema/
slots:
- name
- description
- url
slot_usage:
name:
name: name
required: true
attributes:
hasPrimaryImpact:
name: hasPrimaryImpact
description: The primary impact expected from adhering to the protocol and/or
management practices associated with the credit class. Generally speaking the
quantifiable components of this impact are associated with the credit type that
the credit class exists under (e.g. Carbon, Biodiversity, etc).
from_schema: https://framework.regen.network/schema/
rank: 1000
domain_of:
- CreditClassInfo
range: Impact
required: true
hasCoBenefits:
name: hasCoBenefits
description: Co-benefits are any secondary impacts that may result from adhering
to the protocol and/or management practices associated with the credit class.
They can be qualitative or quantitative.
from_schema: https://framework.regen.network/schema/
rank: 1000
domain_of:
- CreditClassInfo
range: Impact
multivalued: true
sourceRegistry:
name: sourceRegistry
description: The registry where the credits are originally issued and tracked
if somewhere other than Regen Network.
from_schema: https://framework.regen.network/schema/
rank: 1000
domain_of:
- CreditClassInfo
range: Registry
program:
name: program
description: The higher-level rules and requirements under which the given credit
protocol operates, sometimes referred to as the "Standard".
from_schema: https://framework.regen.network/schema/
rank: 1000
domain_of:
- CreditClassInfo
range: CreditingProgram
creditProtocol:
name: creditProtocol
description: The root document of the credit protocol that defines the requirements
and process to register and issue credits under a credit protocol. It could
be registered under a program or independent. It could include methods to measure
and monitor, or reference other methodology documents.
from_schema: https://framework.regen.network/schema/
rank: 1000
domain_of:
- CreditClassInfo
range: CreditProtocol
approvedMethodologies:
name: approvedMethodologies
description: If one or more standalone methodologies for quantifying GHG or other
benefits are approved for use, supplemental to any explicit methodlogies defined
within the main creditProtocol document, they can be listed here.
from_schema: https://framework.regen.network/schema/
rank: 1000
domain_of:
- CreditClassInfo
range: Methodology
multivalued: true
creditingTerm:
name: creditingTerm
description: The total duration of the crediting term for the project.
from_schema: https://framework.regen.network/schema/
rank: 1000
domain_of:
- CreditClassInfo
range: duration
eligibleEcosystemTypes:
name: eligibleEcosystemTypes
description: Types of ecosystems that a project in this credit class may focuses
on.
from_schema: https://framework.regen.network/schema/
rank: 1000
domain_of:
- CreditClassInfo
multivalued: true
eligibleActivities:
name: eligibleActivities
description: Eligible activities for registered projects.
from_schema: https://framework.regen.network/schema/
rank: 1000
domain_of:
- CreditClassInfo
multivalued: true
geographicApplicability:
name: geographicApplicability
description: Geographic applicability of the credit class.
todos:
- Can this be a controlled vocabulary / enum?
from_schema: https://framework.regen.network/schema/
rank: 1000
domain_of:
- CreditClassInfo
</details>
### Induced
<details>
```yaml
name: CreditClassInfo
description: Base class with common fields used to define credit class info.
todos:
- What's the relationship between creditProtocol and approvedMethodologies, in terms
of which is required and not? Should one be folded into the other, or atleast align
on a single class for the fields' ranges?
- what's hte relationship between sourceRegistry and program?
- Should creditProtocol have a field for "program" instead of program living in the
CreditClassInfo?
- are the correct slots required?
- is the inheritiance setup with Biodiv & Carbon correct?
- clarificaiton on naming for primaryImpact & coBenefits?
- should fields in general be switched to snake_case, and use verbs like has_, is_,
or part_of_? (https://linkml.io/linkml/schemas/linter.html#standard-naming)
from_schema: https://framework.regen.network/schema/
slot_usage:
name:
name: name
required: true
attributes:
hasPrimaryImpact:
name: hasPrimaryImpact
description: The primary impact expected from adhering to the protocol and/or
management practices associated with the credit class. Generally speaking the
quantifiable components of this impact are associated with the credit type that
the credit class exists under (e.g. Carbon, Biodiversity, etc).
from_schema: https://framework.regen.network/schema/
rank: 1000
alias: hasPrimaryImpact
owner: CreditClassInfo
domain_of:
- CreditClassInfo
range: Impact
required: true
hasCoBenefits:
name: hasCoBenefits
description: Co-benefits are any secondary impacts that may result from adhering
to the protocol and/or management practices associated with the credit class.
They can be qualitative or quantitative.
from_schema: https://framework.regen.network/schema/
rank: 1000
alias: hasCoBenefits
owner: CreditClassInfo
domain_of:
- CreditClassInfo
range: Impact
multivalued: true
sourceRegistry:
name: sourceRegistry
description: The registry where the credits are originally issued and tracked
if somewhere other than Regen Network.
from_schema: https://framework.regen.network/schema/
rank: 1000
alias: sourceRegistry
owner: CreditClassInfo
domain_of:
- CreditClassInfo
range: Registry
program:
name: program
description: The higher-level rules and requirements under which the given credit
protocol operates, sometimes referred to as the "Standard".
from_schema: https://framework.regen.network/schema/
rank: 1000
alias: program
owner: CreditClassInfo
domain_of:
- CreditClassInfo
range: CreditingProgram
creditProtocol:
name: creditProtocol
description: The root document of the credit protocol that defines the requirements
and process to register and issue credits under a credit protocol. It could
be registered under a program or independent. It could include methods to measure
and monitor, or reference other methodology documents.
from_schema: https://framework.regen.network/schema/
rank: 1000
alias: creditProtocol
owner: CreditClassInfo
domain_of:
- CreditClassInfo
range: CreditProtocol
approvedMethodologies:
name: approvedMethodologies
description: If one or more standalone methodologies for quantifying GHG or other
benefits are approved for use, supplemental to any explicit methodlogies defined
within the main creditProtocol document, they can be listed here.
from_schema: https://framework.regen.network/schema/
rank: 1000
alias: approvedMethodologies
owner: CreditClassInfo
domain_of:
- CreditClassInfo
range: Methodology
multivalued: true
creditingTerm:
name: creditingTerm
description: The total duration of the crediting term for the project.
from_schema: https://framework.regen.network/schema/
rank: 1000
alias: creditingTerm
owner: CreditClassInfo
domain_of:
- CreditClassInfo
range: duration
eligibleEcosystemTypes:
name: eligibleEcosystemTypes
description: Types of ecosystems that a project in this credit class may focuses
on.
from_schema: https://framework.regen.network/schema/
rank: 1000
alias: eligibleEcosystemTypes
owner: CreditClassInfo
domain_of:
- CreditClassInfo
range: string
multivalued: true
eligibleActivities:
name: eligibleActivities
description: Eligible activities for registered projects.
from_schema: https://framework.regen.network/schema/
rank: 1000
alias: eligibleActivities
owner: CreditClassInfo
domain_of:
- CreditClassInfo
range: string
multivalued: true
geographicApplicability:
name: geographicApplicability
description: Geographic applicability of the credit class.
todos:
- Can this be a controlled vocabulary / enum?
from_schema: https://framework.regen.network/schema/
rank: 1000
alias: geographicApplicability
owner: CreditClassInfo
domain_of:
- CreditClassInfo
range: string
name:
name: name
description: Name of the entity / resource.
from_schema: https://framework.regen.network/schema/
rank: 1
slot_uri: schema:name
alias: name
owner: CreditClassInfo
domain_of:
- ProjectInfo
- ProjectRole
- Organization
- File
- Impact
- CreditClassInfo
- Registry
- CreditingProgram
- CreditProtocol
- Methodology
- AdministrativeArea
range: string
required: true
description:
name: description
description: Description of the entity / resource.
from_schema: https://framework.regen.network/schema/
rank: 1
slot_uri: schema:description
alias: description
owner: CreditClassInfo
domain_of:
- ProjectInfo
- ProjectRole
- Organization
- File
- CreditClassInfo
range: string
url:
name: url
description: Link to a valid URL where more information can be found about the
entity / resource.
from_schema: https://framework.regen.network/schema/
rank: 1
slot_uri: schema:url
alias: url
owner: CreditClassInfo
domain_of:
- ProjectRole
- Organization
- CreditClassInfo
- Registry
- CreditingProgram
- CreditProtocol
- Methodology
- AdministrativeArea
range: string