Carbon plugin - updates

source/carbon/checking_data.rst

@@ -0,0 +1,7 @@
+Checking data
+=============
+
+Carbon intensity
+----------------
+
+The plugin downloads carbon intensity from one or several data sources. It may be useful to diagnose wether all required data are downloaded. To do so, an administrator may check the tab Resource diagnosis in the automatic action of the source to examine. This tab shows for **enabled** zones the date intervals of missing data starting from the oldest asset found in GLPI.

source/carbon/configuration.rst

@@ -13,7 +13,13 @@ Downloading carbon intensitiy data
 The plugin implements an automatic action for each data provider. Supported sources are :
 
 * **RTE** for France (free, data back to 2012-01-01)
-* **Electricity Map** for most countries and regions in the world (free access limited to last 24 hours)
+* **Electricity Maps** for most countries and regions in the world (free access limited to last 24 hours or full access with are supported)
+
+.. note::
+    RTE provides date for **produced** electricity only. As France imports and exports electricity the evaluation of **consumed** electricity is slighly different. When it is possible, prefer ElectricityMaps as it takes import / export into account.
+
+.. note::
+    Electricitymaps client supports free and paid access. As there is no way to distinguish these modes from API or the key, you must tick the checkbox "Free mode" if you are using the free access.
 
 When an automatic action runs for the first time it setups supported regions in database. Once done, you may activate downloads for regions of interest.
 
@@ -56,9 +62,9 @@ It also has an automatic action to find the country designation for locations al
 
 To enable it, go to **Setup > Plugins**, locate the Carbon plugin, click on its wrench and check the box **Enable geocoding**.
 
-When the geocoding feature is disabled, it is advised to select the country field manually. This field is under the map and duplicates the native text field **Country** from GLPI.
+When the geocoding feature is disabled, it is advised to select the country field manually. In version 1.0.0 this field is under the map and duplicates the native text field **Country** from GLPI. In version 1.1.0 and later, go to the tab **Environnemental impact** and fill the dropdown **Boavizta zone**.
 
-.. image:: images/location_view.png
+.. image:: images/location_tab_environmental_impact_set_boavizta_zone.png
     :alt: view location information
     :scale: 36%
 
@@ -75,17 +81,23 @@ To do so, the plugin searches for the following dates on order of decreasing pre
 * **startup date** (Financial and administrative informations)
 * **delivery date** (Financial and administrative informations)
 * **date of purchase** (Financial and administrative informations)
-* **creation date in the inventory**
+* **creation date in the inventory** (in version 1.0.0 only)
 
 One of these date fields must be populated.
 
+.. note:: The creation date is ignored starting from version 1.1.0, this means that one of the 3 other fields must be filled.
+
 .. image:: images/financial_information.png
     :alt: view financial information
     :scale: 36%
 
 .. note:: Monitors rely on the location of the computer it is connected to, so there is no need to add it manually
 
-1. The plugin needs to know where is an asset to determine which carbon intensity is applied to its energy consumption. The associated location must have the field **Country** filled, in english language.
+1. The plugin needs to know where is an asset to determine which carbon intensity is applied to its energy consumption. In version 1.0.0 the associated location must have the field **Country** filled, in english language. In version 1.1.0 and later, the carbon intensity location is in the tab **Environmental impact**. The user must choose the source, then the zone (usually a country)
+
+.. image:: images/location_tab_environmental_impact_set_carbon_intensity_source.png
+    :alt: Setting the carbon intensity source of consumed electricity (version 1.1.0 and later)
+    :scale: 43%
 
 2. Each asset must be associated with a model so that the plugin can estimate CO2 emissions as closely as possible. This information can be pre-filled from a `template <https://glpi-user-documentation.readthedocs.io/fr/latest/modules/overview/templates.html>`_
 

source/carbon/features.rst

@@ -26,5 +26,29 @@ the table below describes how assets are supported by the plugin.
 +-------------------+---------------+-----------+-----------+
 | Smartphone        |      Yes      |    Yes    |    No     |
 +-------------------+---------------+-----------+-----------+
+| Tablet            |      Yes      |    Yes    |    No     |
++-------------------+---------------+-----------+-----------+
+
+.. note:: RTE is free; ElectricityMaps is available with a subscription or with a very limitative free access
+
+Features changelog
+==================
+
+Version 1.0.0 (for GLPI 10) and 1.1.0 (for GLPI 11)
+---------------------------------------------------
+
+  Support for 3 impact criteria
+  * GWP (Global Warming Potential)
+  * ADP (Abiotic Depletion Potential) (embodied only)
+  * PE (Primary Energy) (embodied only)
+
+Version 1.1.1 (GLPI 11)
+-----------------------
+
+
+Version 1.2.0
+-------------
 
-.. note:: RTE is free and ElectricityMaps but is very limitative in free version
+* Supports up to 20 impact criteria
+* User defined impact values in asset models, taking precedence over 3rd party evaluation tools
+* Supports paid access to ElectricityMaps

source/carbon/index.rst

@@ -16,3 +16,4 @@ Carbon is a plugin which helps you to monitor environmental footprint of your as
    recommendations
    types_of_impact
    methodology
+   checking data

source/carbon/installation.rst

@@ -4,11 +4,12 @@ Install the Plugin
 From the marketplace
 --------------------
 
-.. warning::
+-  Go to the marketplace. Download and install the plugin **Carbon**.
 
-   The plugin is not available in the marketplace yet.
+.. figure:: images/marketplace.png
+   :alt:
+   :scale: 100 %
 
-   You can install it manually from the archive.
 
 Manually
 --------

source/carbon/limitations.rst

@@ -35,20 +35,7 @@ Therefore the time 2024-03-01 02:00:00 is not visible in the table of carbon int
 
 The reverse occurs on 2023-10-29 02:00:00 where there are two rows with the same date (visible when the table displayed with timezone Europe/Paris) but internally, there is an interval of 1H between them (visible when the table is displayed with UTC)
 
-Not used assets
----------------
-
-Computer
-^^^^^^^^
-
-When a computer is not used it is recommended to remove its usage profile.
-
-Monitor
-^^^^^^^
-
-If there are laptops in the inventory, their internal display may be inventoried. In this case, ensure that it has a model and a type without any power consumption set, or no type or model at all.
-
 Deleted asset
 -------------
 
-GLPI usually handles a trash for assets. A deleted asset will be ignored. When an asset enters or exists the trash then it will be respectively excluded or included in the environmental impact history calculation.
+GLPI usually handles a trash for assets. A deleted asset will be ignored. When an asset enters or exists the trash then it will be respectively excluded or included in the environmental impact history calculation. However, previously calculated impacts will be included in results available in the report or any dashboard which uses the widgets of the plugin.

source/carbon/methodology.rst

@@ -4,8 +4,9 @@ Methodology
 Embodied impacts
 ----------------
 
-Depending on the enabled engine, the methodology of embodied impact may vary.
+The methodology of embodied impact is directly inherited from the external engine used.
 
+Carbon uses the characteristics of assets and its the components (for computers) to describe the asset with repect of expectations of the external engine.
 
 Boaviztapi
 ^^^^^^^^^^
@@ -15,15 +16,17 @@ Boaviztapi is a tool produced by Boavizta, an association helping organizations
 The Carbon plugin sends queries to this tool to get metrics which are locally saved and agregated.
 
 Usage impacts
-----------------
+-------------
 
-The plugin internally calculates the emissions of carbon dioxide equivalent, using the carbon intensity of the local electricity supplier of each asset. Other impacts are calculated by external tools.
+The plugin internally calculates the emissions of carbon dioxide equivalent, using the carbon intensity of the local electricity supplier of each asset. Other impacts are calculated by the external tool enabled in the plugin.
 
 Greenhouse gas emissions
 ^^^^^^^^^^^^^^^^^^^^^^^^
 
-The Carbon plugin identifies the location of an asset, the average power consumption and theoretical power-on and power-off times to approximate the amount of greenhouse gas emitted by the asset's usage.
+The Carbon plugin identifies the location of an asset, the average power consumption and theorical power-on and power-off times to approximate the amount of greenhouse gas emitted by the asset's usage.
 
 The carbon intensity of electricity is collected from local providers and down-sampled to 1 hour time slots. For each asset where there is enough data, the plugin evaluates when it is powered on and calculates the average energy consumed then the carbon emissions of this energy consumption.
 
+When the data source for the location does not provide carbon intensity or when there is no real time data source availabie, the plugin seearches for fallback data in its internal database of yearly carbon intensity per contry. This data comes from https://ourworldindata.org/grapher/carbon-intensity-electricity .
+
 The results are then aggregated by day, and are used to calculate the total carbon emission on a larger time frame, like a month or a year.

source/carbon/reading.rst

@@ -1,5 +1,5 @@
-Reading datas
-=============
+Reading data
+============
 
 In each asset, an Environmental impact tab is now visible.
 
@@ -21,14 +21,15 @@ You can (for computers) select the appropriate profile as well as the planned li
 Historization status
 --------------------
 
-The logging status tells you whether all requirements are correctly met, ensuring that the data sent by Carbon is as accurate as possible.
+The historization status tells you whether all requirements are correctly met, ensuring that the data sent by Carbon is as accurate as possible.
 
 .. image:: images/historization_status.png
     :alt: Read the historization status
     :scale: 61%
 
-If an item is in red, the plugin will operate in a degraded manner, providing less accurate, aggregated estimation information.
-Data in orange are optional items with a slight impact on data quality
+If an item is in red, the plugin will not be able to compute the usage greenhouse gas emissions of the asset.
+Data in orange are optional and missing items. They might degrade the quality of he results.
+Some items may work together. If all items of such group are missing then will show missing and required (red). If one of them is available, the others will show missing (orange).
 
 Usage
 -----

source/carbon/recommendations.rst

@@ -6,7 +6,7 @@ should refer to this page to easily find out which data is missing for a single
 
 Mandatory informations are:
 
-*  A location with a country or a state filled
+*  A location with a carbon intensity source and zone
 *  A startup date or a delivery date
 *  A usage profile for computers
 *  A model or a type

source/carbon/requirements.rst

@@ -14,6 +14,10 @@ GLPI Version Minimum PHP Recommended Minimum DBMS
 ============ =========== =========== ============
 10.0.19       8.2         8.2         Mysql 8.0 or MariaDB 10.2
 ============ =========== =========== ============
+11.0.0        8.2         8.2         Mysql 8.0 or MariaDB 10.2
+============ =========== =========== ============
+
+It is mandatory to `enable timezones in GLPI <https://glpi-install.readthedocs.io/en/latest/timezones.html>` and set the timezone to the host for optimal execution. Not doing so will generate unnecessary HTTP requests to carbon intensitiy providers because of issues with DST handling.
 
 
 .. warning:: For MySQL, a minimum version of 8.0 is required