mescal.generate_lcia_obj_ampl
=============================

.. py:module:: mescal.generate_lcia_obj_ampl


Functions
---------

.. autoapisummary::

   mescal.generate_lcia_obj_ampl.generate_mod_file_ampl


Module Contents
---------------

.. py:function:: generate_mod_file_ampl(self, impact_abbrev: pandas.DataFrame, lcia_methods: list[str], specific_lcia_categories: list[str] = None, specific_lcia_abbrev: list[str] = None, assessment_type: str = 'esm', path: str = None, file_name: str = None, metadata: dict = None, energyscope_version: str = 'epfl') -> None

   Create an AMPL mod file containing the LCIA equations. This method has been specifically designed for the
   EnergyScope model. Currently, it supports the 'epfl' and 'core' versions of EnergyScope.

   :param impact_abbrev: dataframe containing the impact abbreviations of the LCIA method
   :param lcia_methods: LCIA methods to be used
   :param specific_lcia_categories: specific LCIA categories to be used
   :param specific_lcia_abbrev: specific LCIA abbreviations to be used
   :param assessment_type: type of assessment, can be 'esm' for the full LCA database, 'direct emissions' for the
       computation of direct emissions only, or 'territorial emissions' for territorial and abroad emissions.
       Default is 'esm'.
   :param path: path where the mod file will be saved. Default is results_path_file from the ESM class.
   :param file_name: name of the .mod file. Default is 'objectives' if assessment_type is 'esm',
       'objectives_direct' if assessment_type is 'direct emissions', and 'objectives_territorial' if assessment_type is
       'territorial emissions'.
   :param metadata: dictionary containing the metadata to be written at the beginning of the file
   :param energyscope_version: version of EnergyScope model used, can be 'epfl' or 'core'
   :return: None (writes the file)