Update documentation

.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: ddc45f23f34f335fc7531758647eb41e
+tags: 645f666f9bcd5a90fca523b33c5a78b7

.nojekyll

@@ -0,0 +1,19 @@
+# Acknowledgments
+Appa LCA is developed by the DSCIN department of [CEA List](https://list.cea.fr/en/).
+
+The development of Appa LCA has been funded by the [DEEPGREEN](https://deepgreen.ai/) project, a project supported by the French government grant managed by the Agence Nationale de la Recherche under the [France 2030](https://www.economie.gouv.fr/france-2030) program.
+
+The authors would like to thank Bénédicte ROBIN for her participation in maturing Appa LCA. 
+
+<img src="../_static/about/list.jpg" alt="" width="95"/>
+
+<img src="../_static/about/deepgreen.png" alt="" width="70">
+
+<img src="../_static/about/france_2023.jpg" alt="" width="50"/>
+
+## Code contributors
+
+- Maxime PÉRALTA (CEA/List/DSCIN/LIIM)
+- Anne-Lore MONTAGNE (CEA/List/DILS/LIDEO)
+- Romain BOSSY (CEA/List/DSCIN/LIIM)
+- Madeleine ABERNOT (CEA/List/DSCIN/LIIM)

_sources/about/acknowledgments.md.txt

@@ -0,0 +1,16 @@
+# Community
+
+## I have a problem or a question
+If you encounter a problem while using Appa LCA, you can try to see if it is already known in the [FAQ](faq.md) section.
+
+If not, the Issues tab of Appa Build and Appa Run repositories have all chances to be more up to date.
+If your issue is not known, its also there that you can create a new issue so that we are aware of it.
+
+If you have a question or suggestion, we invite you to use the discussion tabs of both Appa Build and Appa Run.
+
+If you're not sure whether your issue or discussion point falls under Appa Build or Appa Run, please prefer Appa Build the repository issues and discussion tabs.
+
+## I want to contribute
+You're very welcomed to contribute to the Appa Build or Appa Run source code, both to fix bugs or add new features.
+
+Feel free to [reach us](mailto:appalca@cea.fr) if you want to collaborate with us in the development of Appa LCA.

_sources/about/community.md.txt

@@ -0,0 +1,23 @@
+# Frequently Asked Questions
+
+## Known limitations
+
+We are aware of some limitations and plan to address them.
+If any of these limitations are limiting problem for you, please feel free to contact us to let us know so we can either prioritize fixing the limitation or help you fix it.
+
+### Versions
+Appa Build currently works with Brightway25 and lca_algebraic_bw25.
+It is tested with Python 3.11.
+
+### Background databases
+At the moment only the EcoInvent background database is supported, as we haven't been able to access and test other databases supported by Brightway.
+Data from other databases can nonetheless be imported at the impact level.
+
+### Methods
+Appa Run uses *Enum* to associate Brightway method names with comprehensive strings.
+We currently only implemented an Enum for PEF v3.0 and v3.1 LCIA methods, and plan to support other methods as well.
+
+You can easily extend the mapping to other LCIA methods. If you do so, it may be a good idea of contribution and could be integrated into Appa LCA's source code.
+
+## Known issues
+We are aware of some issues and bugs. We list them here to keep you informed until we manage to solve them.

_sources/about/faq.md.txt

@@ -0,0 +1,13 @@
+# About
+
+```{toctree}
+:caption: About
+:maxdepth: 2
+:hidden:
+reference.md
+faq.md
+community.md
+acknowledgments.md
+```
+
+<meta http-equiv="refresh" content="0; reference.html">

_sources/about/index.md.txt

@@ -0,0 +1,11 @@
+# Reference
+The journal article for Appa LCA has been submitted to the editor.
+In the meantime, if you communicate about your work using Appa Build and/or Appa Run, you can cite Appa LCA using: 
+
+```
+Peralta, M. (2024, March). Integrating Screening Life Cycle Assessment in Digital System design flow to enable Eco-design. In Date 2024-W01 Eco-ES: Eco-design and circular economy of Electronic Systems.
+```
+
+But please come back to check if the journal paper DOI is available before submitting :)
+
+Please also send an email to [_appalca@cea.fr_](mailto:appalca@cea.fr). It's always interesting to know how this work is being used, and can also motivate us to put more resources into development.

_sources/about/reference.md.txt

@@ -0,0 +1,46 @@
+appabuild.cli.database
+======================
+
+.. py:module:: appabuild.cli.database
+
+
+Attributes
+----------
+
+.. autoapisummary::
+
+   appabuild.cli.database.app
+
+
+Functions
+---------
+
+.. autoapisummary::
+
+   appabuild.cli.database.generate_eime_v6
+
+
+Module Contents
+---------------
+
+.. py:function:: generate_eime_v6(eime_v6_impacts_export_path: str, datasets_description_path: str, output_path: str)
+
+   Generate yaml datasets readily usable by Appa Build from config file and
+   Eime V6 impact exports. To generate the adequate export file, create a new Eime V6
+   project, add a single phase (no particular phase name required), and add a copy of
+   every dataset you want to export. Then, go to analysis page, tick all required PEF
+   impact assessment method, and export the result as a xlsx file.
+   Configuration file should contain all other information of the datasets you want
+   to generate. Common fields across all datasets can be set once in a "default"
+   dict. Specific fields can be provided as a list in a "datasets" dict. Each dataset
+   should have a "name_in_export" key, which value is the name of the corresponding
+   dataset in Eime V6 export.
+   :param eime_v6_impacts_export_path: Eime V6 impact exports
+   :param datasets_description_path: should contain all other information of the
+   datasets you want to generate
+   :param output_path: directory to save yaml files.
+   :return:
+
+
+.. py:data:: app
+

_sources/api/appabuild/cli/database/index.rst.txt

@@ -0,0 +1,17 @@
+appabuild.cli
+=============
+
+.. py:module:: appabuild.cli
+
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 1
+
+   /api/appabuild/cli/database/index
+   /api/appabuild/cli/lca/index
+   /api/appabuild/cli/main/index
+
+

_sources/api/appabuild/cli/index.rst.txt

@@ -0,0 +1,61 @@
+appabuild.cli.lca
+=================
+
+.. py:module:: appabuild.cli.lca
+
+
+Attributes
+----------
+
+.. autoapisummary::
+
+   appabuild.cli.lca.app
+
+
+Functions
+---------
+
+.. autoapisummary::
+
+   appabuild.cli.lca.build
+   appabuild.cli.lca.graph
+   appabuild.cli.lca.validate_foreground_datasets
+   appabuild.cli.lca.validate_size
+   appabuild.cli.lca.validate_type
+
+
+Module Contents
+---------------
+
+.. py:function:: build(appabuild_config_path: Annotated[Optional[str], typer.Argument(help='AppaBuild environment configuration file, required unless --no-init is specified')], lca_config_path: Annotated[str, typer.Argument(help='LCA configuration file')], init: Annotated[bool, typer.Option(help='initialize AppaBuild environment')] = True)
+
+   Build an impact model and save it to the disk.
+   An AppaBuild environment is initialized (background and foreground databases), unless --no-init is specified.
+
+
+
+.. py:function:: graph(path: Annotated[str, typer.Argument(help='Root path of foreground datasets')], fu_name: Annotated[str, typer.Argument(help='Name of the root dataset (without its file extension)')], type: Annotated[str, typer.Option(help='Type of the output image, can only be png or svg, the default type is png', callback=validate_type)] = 'png', width: Annotated[int, typer.Option(help='Width of the output image', callback=validate_size)] = 750, height: Annotated[int, typer.Option(help='Height of the output image', callback=validate_size)] = 750, sensitive: Annotated[bool, typer.Option(help='If the data used to build the graph are sensitive')] = True)
+
+   Generate a mermaid graph from a set of foreground datasets and export it in an image file (PNG or SVG format).
+   :param path: root path of the foreground datasets used to build the graph.
+   :param fu_name: name of the dataset that will be the root of the graph.
+   :param type: type of the output image, can only be png or svg.
+   :param width: width of the output image.
+   :param height: height of the output image.
+   :param sensitive: if true, ask with a prompt if the data used to build the graph are sensitive.
+
+
+
+.. py:function:: validate_foreground_datasets(datasets_root: Annotated[str, typer.Argument(help='Root path of a set of foreground datasets.')])
+
+   Validates a folder of foreground datasets. Show an error message for each invalid dataset.
+   :param datasets_root: Root path of a set of foreground datasets.
+
+
+
+.. py:function:: validate_size(size: int) -> int
+
+.. py:function:: validate_type(type: str) -> str
+
+.. py:data:: app
+