T-reX.config.user_settings
==========================

.. py:module:: T-reX.config.user_settings

.. autoapi-nested-parse::

   user_settings Module
   ====================

   Configure Project and Database Settings for T-reX.

   This script is used to configure the project and database settings, as well as set up the essential paths for the data, config, and result directories.

   The script allows for two modes of operation:
       1. Single Mode (`single` is True): Set the project and database names to a single specified value.
       2. Multiple projects/databases mode (`single` is False): Facilitates batch processing of multiple projects and databases.

   Additionally, the script allows for the use of multiprocessing (`use_multiprocessing` is True). (not working in premise update)

   Premise can also be used to make future databases (`use_premise` is True).




Attributes
----------

.. autoapisummary::

   T-reX.config.user_settings.custom_bw2_dir
   T-reX.config.user_settings.biosphere_name
   T-reX.config.user_settings.project_premise_base
   T-reX.config.user_settings.project_premise
   T-reX.config.user_settings.project_base
   T-reX.config.user_settings.project_T_reX
   T-reX.config.user_settings.use_T_reX
   T-reX.config.user_settings.db_T_reX_name
   T-reX.config.user_settings.single
   T-reX.config.user_settings.single_database
   T-reX.config.user_settings.delete_T_reX_project
   T-reX.config.user_settings.use_multiprocessing
   T-reX.config.user_settings.verbose
   T-reX.config.user_settings.do_search
   T-reX.config.user_settings.do_methods
   T-reX.config.user_settings.do_edit
   T-reX.config.user_settings.use_premise
   T-reX.config.user_settings.database_name
   T-reX.config.user_settings.database_biosphere
   T-reX.config.user_settings.delete_existing_premise_project
   T-reX.config.user_settings.use_mp
   T-reX.config.user_settings.batch_size
   T-reX.config.user_settings.premise_quiet
   T-reX.config.user_settings.project_T_reX
   T-reX.config.user_settings.premise_key
   T-reX.config.user_settings.key_path
   T-reX.config.user_settings.models
   T-reX.config.user_settings.ssps
   T-reX.config.user_settings.rcps
   T-reX.config.user_settings.years
   T-reX.config.user_settings.desired_scenarios
   T-reX.config.user_settings.cwd
   T-reX.config.user_settings.dir_config
   T-reX.config.user_settings.dir_data
   T-reX.config.user_settings.dir_tmp
   T-reX.config.user_settings.dir_logs
   T-reX.config.user_settings.dir_searchwaste_results
   T-reX.config.user_settings.dir_searchmaterial_results
   T-reX.config.user_settings.dir_databases_T_reX
   T-reX.config.user_settings.dir_T_reX


Functions
---------

.. autoapisummary::

   T-reX.config.user_settings.generate_args_list


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

.. py:data:: custom_bw2_dir
   :value: None


.. py:data:: biosphere_name
   :value: 'biosphere'


.. py:data:: project_premise_base
   :value: 'default'


.. py:data:: project_premise
   :value: 'premise-SSP2-cutoff'


.. py:data:: project_base
   :value: 'premise-SSP2-cutoff'


.. py:data:: project_T_reX
   :value: 'TreX-premise-SSP2-cutoff'


.. py:data:: use_T_reX
   :value: True


.. py:data:: db_T_reX_name
   :value: 'biosphere_T-reX'


.. py:data:: single
   :value: False


.. py:data:: single_database
   :value: 'ecoinvent_cutoff_3.9_remind_SSP2-Base_2065'


.. py:data:: delete_T_reX_project
   :value: True


.. py:data:: use_multiprocessing
   :value: False


.. py:data:: verbose
   :value: False


.. py:data:: do_search
   :value: True


.. py:data:: do_methods
   :value: True


.. py:data:: do_edit
   :value: True


.. py:data:: use_premise
   :value: True


.. py:data:: database_name
   :value: 'ecoinvent-3.10-cutoff'


.. py:data:: database_biosphere
   :value: 'ecoinvent-3.10-biosphere'


.. py:data:: delete_existing_premise_project
   :value: True


.. py:data:: use_mp
   :value: True


.. py:data:: batch_size
   :value: 3


.. py:data:: premise_quiet
   :value: False


.. py:data:: project_T_reX
   :value: 'T-reX-premise-SSP2-cutoff'


.. py:data:: premise_key
   :value: 'tUePmX_S5B8ieZkkM7WUU2CnO8SmShwmAeWK9x2rTFo='


.. py:data:: key_path

.. py:data:: models
   :value: ['remind']


.. py:data:: ssps
   :value: ['SSP2']


.. py:data:: rcps
   :value: ['Base']


.. py:data:: years
   :value: [2050]


.. py:data:: desired_scenarios
   :value: []


.. py:function:: generate_args_list(single_database=None)

   Generate a list of argument dictionaries for processing multiple projects and databases.

   This function is used when the tool is set to operate in multiple projects/databases mode.
   It generates a list of argument dictionaries, each containing project and database settings.

   :returns: A list of dictionaries with project and database settings for batch processing.


.. py:data:: cwd

.. py:data:: dir_config

.. py:data:: dir_data

.. py:data:: dir_tmp

.. py:data:: dir_logs

.. py:data:: dir_searchwaste_results

.. py:data:: dir_searchmaterial_results

.. py:data:: dir_databases_T_reX

.. py:data:: dir_T_reX