Skip to main content

​
Understanding [TOPIC_NAME]

[TOPIC_NAME] [describe what this topic covers and why it matters]. According to the relevant standard/reference, this includes:
  • [Category 1]: [Description]
  • [Category 2]: [Description]
  • [Category 3]: [Description]
  • [Category 4]: [Description]
┌─────────────────────────────────────────────────────────────────────────────┐
│                           [DIAGRAM_TITLE]                                   │
├─────────────────────┬─────────────────────┬─────────────────────────────────┤
│  [Column 1]         │  [Column 2]         │  [Column 3]                     │
│  [Header]           │  [Header]           │  [Header]                       │
├─────────────────────┼─────────────────────┼─────────────────────────────────┤
│  • [Item 1]         │  • [Item 1]         │  • [Item 1]                     │
│  • [Item 2]         │  • [Item 2]         │  • [Item 2]                     │
│  • [Item 3]         │  • [Item 3]         │  • [Item 3]                     │
│  • [Item 4]         │  • [Item 4]         │  • [Item 4]                     │
└─────────────────────┴─────────────────────┴─────────────────────────────────┘
[KEY_CONCEPT_TITLE][Explain the key formula, concept, or methodology][FORMULA_NAME] = [FORMULA]Where:
  • [Variable 1]: [Description]
  • [Variable 2]: [Description]
  • [Variable 3]: [Description]

​
Prerequisites

Before starting, ensure you have:
  • Dcycle API credentials (get them here)
  • [Prerequisite 2]
  • [Prerequisite 3]
Using the Dcycle App?You can also manage this through our web interface:

​
Data Map: [TOPIC] Requirements Overview

Before diving into the calculations, here’s a complete overview of the data you’ll need: 
┌─────────────────────────────────────────────────────────────────────────────────────────┐
│                        [TOPIC] DATA REQUIREMENTS OVERVIEW                               │
├─────────────────────────────────────────────────────────────────────────────────────────┤
│                                                                                         │
│  ┌─────────────────────────────────────────────────────────────────────────────────┐   │
│  │ [SECTION 1] (Steps X.1 - X.N)                                                   │   │
│  ├─────────────────────────────────────────────────────────────────────────────────┤   │
│  │                                                                                 │   │
│  │  [Category 1]              [Category 2]          [Category 3]                   │   │
│  │  ─────────────────         ────────────          ─────────────────              │   │
│  │  • [Field 1]               • [Field 1]           • [Field 1]                    │   │
│  │  • [Field 2]               • [Field 2]           • [Field 2]                    │   │
│  │  • [Field 3]               • [Field 3]           • [Field 3]                    │   │
│  │  • [Field 4]               • [Field 4]           • [Field 4]                    │   │
│  │                                                                                 │   │
│  └─────────────────────────────────────────────────────────────────────────────────┘   │
│                                                                                         │
│  ┌─────────────────────────────────────────────────────────────────────────────────┐   │
│  │ [SECTION 2] (Steps X.N+1 - X.M)                                                 │   │
│  ├─────────────────────────────────────────────────────────────────────────────────┤   │
│  │                                                                                 │   │
│  │  [Category 1]              [Category 2]                                         │   │
│  │  ────────────────────      ────────────────                                     │   │
│  │  • [Field 1]               • [Field 1]                                          │   │
│  │  • [Field 2]               • [Field 2]                                          │   │
│  │  • [Field 3]               • [Field 3]                                          │   │
│  │  • [Field 4]               • [Field 4]                                          │   │
│  │                                                                                 │   │
│  └─────────────────────────────────────────────────────────────────────────────────┘   │
│                                                                                         │
└─────────────────────────────────────────────────────────────────────────────────────────┘

​
[MAIN_SECTION_TITLE]

[Introduction to this section - what it covers and how Dcycle handles it]

​
Emission Sources Covered

Source Type[Column 2]Examples
[Type 1][value][Examples]
[Type 2][value][Examples]
[Type 3][value][Examples]
[Type 4][value][Examples]

​
Calculation Methods by [CATEGORY]

For [context], Dcycle uses [methodology] from [Source].
[Flow diagram showing the process]
[Input] → [Step 1] → [Step 2] → [Output]
      ↓         ↓           ↓           ↓
  [Detail]  [Detail]    [Detail]    [Detail]
Key characteristics:
  • [Characteristic 1]
  • [Characteristic 2]
  • [Characteristic 3]
  • [Characteristic 4]
Access [resource name] here.
For [context], Dcycle uses emission factors from:Factors are automatically selected based on:
  • [Selection criteria 1]
  • [Selection criteria 2]
  • [Selection criteria 3]
[Explain the calculation methodology][Formula Name] = [Formula]Where:
  • [Variable 1]: [Description]
  • [Variable 2]: [Description]
  • [Variable 3]: [Description]
Example ([specific case]):
[Step-by-step calculation example]
Automatic [Feature] SelectionYou don’t need to specify [what]. Dcycle automatically detects [criteria] and applies the correct [settings]:
  • [condition 1] → [result 1]
  • [condition 2] → [result 2]
What you’ll track: 
[Stage 1] → [Stage 2] → [Stage 3]
      ↓           ↓            ↓
  [Detail]    [Detail]     [Detail]

​
Data Flow

1

[Step 1 Title]

[Step 1 description]
2

[Step 2 Title]

[Step 2 description]
3

[Step 3 Title]

[Step 3 description]
4

[Step 4 Title]

[Step 4 description]
5

[Step 5 Title]

[Step 5 description]

​
Step [X.1]: [Step Title]

FieldTypeRequiredDescriptionExample
[field_name]string✅[Description]"[example]"
[field_name]UUID✅[Description]"abc-123-..."
[field_name]number✅[Description]5000
[field_name]date✅[Description]"2024-01-01"
[field_name]UUID❌[Optional field description]"optional-uuid"
Where to get this data:
  • [Field 1]: [Source/method to obtain]
  • [Field 2]: [API endpoint or manual source]
  • [Field 3]: [Data source description]
[Brief introduction to what this step accomplishes] 
import requests
import os

headers = {
    "Authorization": f"Bearer {os.getenv('DCYCLE_API_KEY')}",
    "Content-Type": "application/json",
    "x-organization-id": os.getenv("DCYCLE_ORG_ID"),
    "x-user-id": os.getenv("DCYCLE_USER_ID"),
}

# [Comment explaining what this code does]
[variable] = "[value]"

# [Step 1 comment]
response = requests.get(
    f"https://api.dcycle.io/api/v1/[endpoint]/{[variable]}",
    headers=headers,
).json()

# [Step 2 comment]
data = {
    "[field_1]": "[value]",
    "[field_2]": [value],
    "[field_3]": "[value]",
}

# [Step 3 comment]
response = requests.post(
    "https://api.dcycle.io/api/v1/[endpoint]",
    headers=headers,
    json=data,
)

result = response.json()
print(f"✅ [Success message]: {result['id']}")
print(f"   [Additional info]: {result['field']}")
[Helpful Tip Title][Tip content explaining a best practice, shortcut, or recommendation]

​
Step [X.2]: [Step Title]

FieldTypeRequiredDescriptionExample
[field_name]string✅[Description]"[example]"
[field_name]UUID✅[Description]"abc-123-..."
[field_name]number✅[Description]250
Where to get this data:
  • [Field 1]: [Source/method to obtain]
  • [Field 2]: [API endpoint or manual source]
[Brief description of this step and when to use it] 
# [Code example for this step]
data = {
    "[field_1]": "[value]",
    "[field_2]": [value],
}

response = requests.post(
    "https://api.dcycle.io/api/v1/[endpoint]",
    headers=headers,
    json=data,
)

print(f"✅ [Success message]: {response.json()['id']}")
[Warning Title][Important warning about potential issues, high-impact items, or common mistakes]
  • [Item 1]: [Value/impact]
  • [Item 2]: [Value/impact]
  • [Item 3]: [Value/impact]
[Additional context or recommendation]
[Note Title][Important information about behavior, distinctions, or clarifications]
  • Use [option A] when [condition A]
  • Use [option B] when [condition B]
Example: [Concrete example to illustrate the note]

​
[SECONDARY_SECTION_TITLE]

[Introduction to secondary section]
[Content]
[Content with formula or methodology][Formula] = [Expression]Where:
  • [Variable 1]: [Description]
  • [Variable 2]: [Description]
[Content]

​
CSV Format for [Data Type]

[column1],[column2],[column3],[column4],[column5]
[example_row_1]
[example_row_2]
[example_row_3]

​
Query [Data Type]

# [Code example for querying/retrieving data]
response = requests.get(
    f"https://api.dcycle.io/api/v1/[endpoint]/{[id]}",
    headers=headers,
    params={
        "page": 1,
        "size": 50,
        "[filter_1]": "[value]",
        "[filter_2]": "[value]",
    },
).json()

print(f"📊 [Data Type]:")
for item in response["items"]:
    print(f"   {item['field_1']} - {item['field_2']}")
    print(f"   [Label]: {item['field_3']}")
    print()
Best Practice: [Practice Title]For complete [topic] accounting:
  1. [Recommendation 1]: [Description]
  2. [Recommendation 2]: [Description]
  3. [Recommendation 3]: [Description]
Use the [field] field ([option A] or [option B]) to distinguish.