CFP Quick Start Guide

CFP Quick Start Guide

Welcome to the Cool Farm Platform!

This Quick Start Guide will walk you through the registration process and help you take your first steps with the Cool Farm Platform (CFP). 


Registration

  1. Go to https://cfp.coolfarm.org/.
  2. Click on Sign in. If you haven’t created an account yet, click on Sign up. NOTE: If you had an account in the in the Cool Farm Tool, use the same email address and username. This could help us matching up your profiles once we migrate accounts from the Cool Farm Tool to Cool Farm Platform.
  3. After filling your details and clicking on Sign up, fill in the verification code that has been sent to you via email (please check your junk folder if you cannot find the email in your inbox).
  4. Click on Confirm Account. You will now be logged in and taken to the CFP Homepage.
  5. Start creating a farm or create a new assessment.
  6. Please consult the info buttons for each field for further guidance.

📽️ Video: How to register an account



Navigation Menu


Assessments: A list of all the assessments previously created in your account.

Farms: Create your farm(s) specifying details such as location and climate. When starting an assessment, you can select one of your farms to apply its specific conditions to the assessment.

API Docs: This section provides API users with access to various endpoints, such as posting or retrieving assessments, exporting data schemas, and creating app keys. These endpoints are available exclusively to API-license users; others are restricted to read-only access (except soil characteristic, see Farms below).

Knowledge Base: The Knowledge Base is a continuously growing collection of answers to key questions and issues raised by CFP users. Make sure you check this regularly to find immediate support for common questions. Remember that in the Technical Documentation or our Lay Guides you find all the details around the methodology of the Cool Farm Platform which may give you the answer you are looking for.

Support Form: If you still didn’t find your answer in the Knowledge Base or Tool Tip and have difficulties to move around or complete an assessment, you can use the "Support Form" to send your queries directly to us.



Creating & Editing Farms

If you would like to create a new farm in the Cool Farm Platform, follow these steps:

  1. Go to the Farms section in the left-hand navigation.
  2. Click the Create New Farm button.
  3. Enter the required information.

💡 Tips to help you

  1. You can set your location and coordinates by clicking on the map or by entering them manually.
  2. To define your climate zone, use the IPCC map provided in the Tool Tip.
    Note: Browser translations may not distinguish between certain climates, e.g. 'moist' and 'wet' in Spanish. For accuracy, please refer to the original English version.
  3. You can define your farm's soil characteristic using the respective endpoint in the API Docs endpoint in the navigation panel. This endpoint is available to any user to retrieve the characteristic specific to their coordinates. Follow these steps:
    1. Before starting to create a farm or while doing so, save your farm and go to API Docs in the navigation menu.
    2. Click on the right arrow of the soil characteristic endpoint and click on try out.
    3. Enter latitude and longitude.
    4. Click on execute.
    5. You can now use the soil characteristic indicated in the response below and copy into your farm settings.

📽️ Video: How to create a farm


How to edit an existing farm

If you wish to edit a farm that you have already created, you can do so from the farms section on the left-hand navigation. Then click on the small arrow on the right-hand side to edit.



Assessments

  1. Display all saved assessments as cards or list and view basic information such as total emissions, the crop and year assessed, the status of submission and the aggregation groups it has been shared with.
  2. On this page you can also duplicate an assessment by clicking on the three dots or the copy symbol.

The are three statuses for assessments:

  1. In Progress: A new assessment is currently being edited but has not been completed and submitted yet. Results show as 0 because they haven't been calculated yet.
  2. Submitted: Assessment data has been submitted and results have been calculated. This assessment is completed.
  3. Edit in progress: This is an assessment that was changed after submission but edits haven’t been submitted, or a copied assessment that hasn’t been revised and submitted again.



Assessment Overview

When opening an assessment, the overview indicates which sections contain data (complete), are missing information (invalid) or are not filled out (disabled). This helps you quickly identify which sections may need editing.


You can also see total results, aggregation groups (when the assessment has been shared) and calculation results from older versions - called ‘old runs’.

Delete an assessment

To prevent accidental deletion, the assessment can only be deleted from within the assessment overview. Open the assessment and click the delete assessment button at the top right.



Assessment Data

  1. Each assessment has a unique ID which is on the to bar of the assessment.

  1. Once you've started an assessment, use the tabs on the right side of the screen to navigate between model sections. As you move between sections, your inputs are saved automatically and the ‘Live Summary’ updates in real time. Icons indicate whether a section is complete or has missing information.
  2. The ‘Live Summary’ of emissions and removals per model is initially hidden at the top of the page. Click the arrow in the top-right corner to expand it. Hover over the bars to view emissions and removals in kg CO₂e.
  3. To ensure the summary reflects the latest data, click the Refresh button—it both updates the summary and saves your inputs. If you've made changes within a section, be sure to either click Refresh or switch to another section to trigger an update.
  4. Click on the little 'i' next to each section title or field to find helpful guidance on how to complete an assessment.
  5. Error messages on the top will tell you what type of fields or data are missing or incorrect. An error report with all errors in the assessment can be viewed via the button on the top right. This report will also pop up when submitting your assessment to make sure all necessary data is completed.


View & Export Results

  1. Click on submit assessment to view the final results.
  2. Here you can see the emissions and removals in CO2e for the assessment year as total and as graph per model (category).
  3. For perennials, you can also see results for the whole crop lifecycle and a special breakdown of residue emissions that can help you predict and simulate effect of practices and management changes over time.


  1. The detailed data table disaggregates emissions per gas and shows results as total per model as well as per area and per product (tonne at farm gate). The table can be exported as JSON or CSV file.

  1. The disaggregated results for each item (e.g. per transport/machinery/fertiliser application) are available by exporting the raw results. Currently this is only available in JSON format (we will consider making export as CSV/Excel table available in future releases).

Getting back to assessment from results

You can access the assessment from the results by clicking the name of the assessment in the breadcrumb trail at the top of the results page:



📽️Video: Top Tips to get you started



    • Related Articles

    • Cool Farm Tool User Guide-Crops

      Find attached our Cool Farm Tool User Guide for Crops. (please note these are due to be updated shortly)
    • Cool Farm Tool User Guide- Livestock (Beef & Dairy)

      Find attached our Cool Farm Tool User Guide for Livestock (Beef & Dairy).
    • Cool Farm Tool Quick Start Guide

      Here's a helpful guide for the first steps in the Cool Farm Tool, as well as setting up data sharing and account features with codes exclusive to our members.
    • API user guide

      For the latest CFP API user guide visit this link https://coolfarmalliance.atlassian.net/wiki/external/ZDA1NzFiZjJkODZlNDdmMDg5YjcyY2RhYzVlMzdkMWM
    • What training materials are available for CFP 3.0?

      To help you get off to a smooth and confident start with the Cool Farm Platform 3.0, we’ve gathered all essential training resources below (links will be added once documents are ready): Getting Started Cool Farm Platform Quickstart Guide Short demo ...