Skip to main content

Configuring Model Sections & Field Libraries

Review of the Model Organization​

Models are organized hierarchically to structure your LCA calculations:

Creating Model Sections​

Sections are the top level of organization in a Model. Model Sections group together related Formulas and Field Libraries, like formulas and fields related to an emission category or calculation stage.

Creating a Section​

To create a model section, use POST /v0/models/{id}/sections:

Create model section
curl -X 'POST' "/v0/models/{id}/sections" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $BEARER" \
  -d '{ \
    "label": "Production Emissions", \
    "description": "Emissions from production activities" \
  }'

Parameters​

label
string or null
description
string or null

Listing Model Sections​

To view all sections for a model, use GET /v0/models/{id}/sections:

Get model sections
curl -X 'GET' "/v0/models/{id}/sections" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $BEARER"

Response Schema​

id
required
string
label
required
string or null
description
required
string or null

Getting a Specific Section​

To retrieve details about a specific section:

Get model section
curl -X 'GET' "/v0/model-sections/{id}" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $BEARER"

Updating a Section​

To update a section's label or description:

Update model section
curl -X 'PATCH' "/v0/model-sections/{id}" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $BEARER" \
  -d '{ \
    "label": "Updated Section Name", \
    "description": "Updated description" \
  }'

Deleting a Section​

To delete a model section:

Delete model section
curl -X 'DELETE' "/v0/model-sections/{id}" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $BEARER"
Deletion Warning

Deleting a section will remove all associated field libraries, fields, and formulas. This action cannot be undone.

Creating Field Libraries​

Field Libraries are components within a Section that group related Fields together. They help organize data inputs logically.

Creating a Field Library​

To create a field library within a section, use POST /v0/model-sections/{id}/field-libraries:

Create field library
curl -X 'POST' "/v0/model-sections/{id}/field-libraries" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $BEARER" \
  -d '{ \
    "label": "Feedstock Data", \
    "description": "Input data related to feedstock sourcing and processing" \
  }'

Parameters​

  • label (optional) - Human-readable name for the field library
  • description (optional) - Description of what fields this library contains

Listing Field Libraries​

To view all field libraries for a section:

Get field libraries
curl -X 'GET' "/v0/model-sections/{id}/field-libraries" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $BEARER"

Response Schema​

id
required
string
label
required
string or null
description
required
string or null
sectionId
required
string

Deleting a Field Library​

To delete a field library:

Delete field library
curl -X 'DELETE' "/v0/field-libraries/{id}" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $BEARER"
Deletion Warning

Deleting a field library will remove all fields it contains. This action cannot be undone.

Common Section Examples​

Typical examples of Sections in LCA models:

  • CORCs Equation - The overall number of CORCs (i.e. the total net amount of CO2 removed) during a Monitoring Period.
  • C_Stored - The gross amount of carbon stored calculated at the batch level.
  • E_Production - Operational lifecycle emissions incurred during the Monitoring Period.

Next Steps​

With your model structure in place (sections and field libraries), you're ready to create the fields and formulas that will perform the actual calculations.