@hestia-earth/schema/Completeness.d.ts

Hestia Schema

import { JSON, SchemaType } from './types';
/**
 * A specification of how complete the [Inputs](./Input) and [Products](./Product) data are. Each field in Completeness corresponds to one or more [termTypes](./Term#termType) in the Glossary. If a termType is marked "complete", then any Inputs or Products of that termType which are not present in the Cycle, have a value of zero.
 */
export declare class Completeness extends JSON<SchemaType.Completeness> {
    /**
    * <table class="sub-table">   <tbody>
       <tr>
         <td class="w-100">All [electricity](/glossary?termType=electricity) and [fuel](/glossary?termType=fuel)
           used during the [Cycle] are recorded.</td>
         <td class="sub-table-value">Set to <code>true</code></td>
       </tr>
       <tr>
         <td class="w-100">Electricity and fuel are not used during the Cycle.</td>
         <td class="sub-table-value">Set to <code>true</code></td>
       </tr>
       <tr>
         <td class="w-100">Electricity and/or fuel are used during the Cycle but not fully recorded.</td>
         <td class="sub-table-value">Set to <code>false</code></td>
       </tr>
     </tbody>
   </table>
    */
    electricityFuel?: boolean;
    /**
    * <table class="sub-table">   <tbody>
       <tr>
         <td class="w-100">All [material](/glossary?termType=material) Inputs, which includes infrastructure use
           depreciated over the [Cycle], are recorded.</td>
         <td class="sub-table-value">Set to <code>true</code></td>
       </tr>
       <tr>
         <td class="w-100">No material inputs are used during the Cycle.</td>
         <td class="sub-table-value">Set to <code>true</code></td>
       </tr>
       <tr>
         <td class="w-100">Material inputs are used during the Cycle but are not fully recorded.</td>
         <td class="sub-table-value">Set to <code>false</code></td>
       </tr>
     </tbody>
   </table>
    */
    material?: boolean;
    /**
    * <table class="sub-table">   <tbody>
       <tr>
         <td class="w-100">All [organic](/glossary?termType=organicFertilizer) and
           [inorganic](/glossary?termType=inorganicFertilizer) fertilizers used during the
           [Cycle] are recorded.</td>
         <td class="sub-table-value">Set to <code>true</code></td>
       </tr>
       <tr>
         <td class="w-100">No fertilizers are used during the Cycle.</td>
         <td class="sub-table-value">Set to <code>true</code></td>
       </tr>
       <tr>
         <td class="w-100">Fertilizers are used during the Cycle but are not fully recorded.</td>
         <td class="sub-table-value">Set to <code>false</code></td>
       </tr>
     </tbody>
   </table>
    */
    fertilizer?: boolean;
    /**
    * <table class="sub-table">   <tbody>
       <tr>
         <td class="w-100">All [soil amendments](/glossary?termType=soilAmendment) used during the [Cycle]
           are recorded.</td>
         <td class="sub-table-value">Set to <code>true</code></td>
       </tr>
       <tr>
         <td class="w-100">No soil amendments are used during the Cycle.</td>
         <td class="sub-table-value">Set to <code>true</code></td>
       </tr>
       <tr>
         <td class="w-100">Soil amendments  are used during the Cycle but are not fully recorded.</td>
         <td class="sub-table-value">Set to <code>false</code></td>
       </tr>
     </tbody>
   </table>
    */
    soilAmendments?: boolean;
    /**
    * <table class="sub-table">   <tbody>
       <tr>
         <td class="w-100">All pesticides (either as [active ingredients](/glossary?termType=pesticideAI)
           or [brand names](/glossary?termType=pesticideBrandName)) and
           [antibiotics](/glossary?termType=antibiotic) used during the [Cycle] are recorded.</td>
         <td class="sub-table-value">Set to <code>true</code></td>
       </tr>
       <tr>
         <td class="w-100">No pesticides or antibiotics are used during the Cycle.</td>
         <td class="sub-table-value">Set to <code>true</code></td>
       </tr>
       <tr>
         <td class="w-100">Pesticides and/or antiboitics are used during the Cycle but are not fully recorded.</td>
         <td class="sub-table-value">Set to <code>false</code></td>
       </tr>
     </tbody>
   </table>
    */
    pesticidesAntibiotics?: boolean;
    /**
    * <table class="sub-table">   <tbody>
       <tr>
         <td class="w-100">The amount of [water](/glossary?termType=water) used during the [Cycle] is
           recorded.</td>
         <td class="sub-table-value">Set to <code>true</code></td>
       </tr>
       <tr>
         <td class="w-100">No water is used during the Cycle.</td>
         <td class="sub-table-value">Set to <code>true</code></td>
       </tr>
       <tr>
         <td class="w-100">Water is used during the Cycle but is not fully recorded.</td>
         <td class="sub-table-value">Set to <code>false</code></td>
       </tr>
     </tbody>
   </table>
    */
    water?: boolean;
    /**
    * <table class="sub-table">   <tbody>
       <tr>
         <td class="w-100">All the animal feeds ([crop](/glossary?termType=crop) Inputs into a Cycle with [live animal](/glossary?termType=liveAnimal), [live aquatic species](/glossary?termType=liveAquaticSpecies), or [animal product](/glossary?termType=animalProduct) as Products) and their amounts are specified.</td>
         <td class="sub-table-value">Set to <code>true</code></td>
       </tr>
       <tr>
         <td class="w-100">No animal feed is used during the Cycle.</td>
         <td class="sub-table-value">Set to <code>true</code></td>
       </tr>
       <tr>
         <td class="w-100">Animal feed is used during the Cycle but is not fully recorded.</td>
         <td class="sub-table-value">Set to <code>false</code></td>
       </tr>
     </tbody>
   </table>
    */
    animalFeed?: boolean;
    /**
    * <table class="sub-table">  <tbody>
      <tr>
        <td class="w-100">All [other](/glossary?termType=other) Inputs, which includes [seed](/term/seed),
            are recorded.</td>
        <td class="sub-table-value">Set to <code>true</code></td>
      </tr>
      <tr>
        <td class="w-100">No other Inputs are used during the Cycle.</td>
        <td class="sub-table-value">Set to <code>true</code></td>
      </tr>
      <tr>
        <td class="w-100">Other Inputs are used during the Cycle but are not fully recorded.</td>
        <td class="sub-table-value">Set to <code>false</code></td>
      </tr>
    </tbody>
  </table>
    */
    other?: boolean;
    /**
    * <table class="sub-table">  <tbody>
      <tr>
        <td class="w-100">All
          [crop](/glossary?termType=crop),
          [live animal](/glossary?termType=liveAnimal),
          [live aquatic species](/glossary?termType=liveAquaticSpecies),
          [animal product](/glossary?termType=animalProduct) and
          [processed food](/glossary?termType=processedFood)
          produced during the [Cycle] are recorded.
        </td>
        <td class="sub-table-value">Set to <code>true</code></td>
      </tr>
      <tr>
        <td class="w-100">No Products are produced during the Cycle.</td>
        <td class="sub-table-value">Set to <code>true</code></td>
      </tr>
      <tr>
        <td class="w-100">Products are produced during the Cycle but are not fully recorded
          (note that [crop residue](#cropResidue) and [excreta and its management](#excretaManagement)
          are specified separately).</td>
        <td class="sub-table-value">Set to <code>false</code></td>
      </tr>
    </tbody>
  </table>
    */
    products?: boolean;
    /**
    * <table class="sub-table">  <tbody>
      <tr>
        <td class="w-100">The quantities of above and below ground
          [crop residue](/glossary?termType=cropResidue) created during the [Cycle] are
          recorded.</td>
        <td class="sub-table-value">Set to <code>true</code></td>
      </tr>
      <tr>
        <td class="w-100">No crop residue is created during the Cycle.</td>
        <td class="sub-table-value">Set to <code>true</code></td>
      </tr>
      <tr>
        <td class="w-100">Crop residue is created during the Cycle but is not fully recorded.</td>
        <td class="sub-table-value">Set to <code>false</code></td>
      </tr>
    </tbody>
  </table>
    */
    cropResidue?: boolean;
    /**
    * <table class="sub-table">  <tbody>
      <tr>
        <td class="w-100">The [excreta management](/glossary?termType=excretaManagement) systems used are
          specified. (Note these are specified by adding a [Transformation](/schema/Transformation)
          to a Cycle, and setting using the [term](/schema/Transformation#term) to describe
          the system).</td>
        <td class="sub-table-value">Set to <code>true</code></td>
      </tr>
      <tr>
        <td class="w-100">No excreta is created or managed during the Cycle.</td>
        <td class="sub-table-value">Set to <code>true</code></td>
      </tr>
      <tr>
        <td class="w-100">Excreta is created or managed during the Cycle but is not fully recorded.</td>
        <td class="sub-table-value">Set to <code>false</code></td>
      </tr>
    </tbody>
  </table>
    */
    excretaManagement?: boolean;
    /**
    * The version of the schema when these data were created.
    */
    schemaVersion?: string;
    /**
    * A list of fields that have been added to the original dataset.
    */
    added?: (string)[];
    /**
    * A list of versions of the model used to add these fields.
    */
    addedVersion?: (string)[];
    /**
    * A list of fields that have been updated on the original dataset.
    */
    updated?: (string)[];
    /**
    * A list of versions of the model used to update these fields.
    */
    updatedVersion?: (string)[];
}