<commit_before>.. automodule:: pyhector
    :members:
    :undoc-members:
    :show-inheritance:

pyhector.constants
------------------

Dictionaries ``components`` and ``variables`` used for mapping categories
internally. Auto-generated from Hector headers.


pyhector.default_config
-----------------------

A dictionary with Hector's default configuration parameters.
See also `the original config file on GitHub <https://github.com/openclimatedata/pyhector/blob/master/pyhector/rcp_default.ini>`_.
In **pyhector** this INI-file is represented as a dictionary.

pyhector.emissions
------------------

A dictionary with mapping from Hector components to emissions used in
the respective component.

.. exec::
    from pyhector import emissions
    sorted_emissions = sorted(emissions.items())
    for item in sorted_emissions:
        print("- ``{}``: {}".format(item[0], item[1]))
pyhector.output
---------------

A dictionary with Hector's available output variables

    output = {
        'C2F6_halocarbon.hc_concentration': {
            'component': 'C2F6_halocarbon',
            'description': 'C2F6 concentration',
            'unit': 'pptv',
            'variable': 'hc_concentration'
        },
        [...]

Full list below, sorted by dictionary key "component.variable", showing
description and the associated unit:

.. exec::
    from pyhector import variables
    template = "- ``{}.{}``, {}, {}"
    sorted_variables = sorted(variables.items(),
                              key=variables.get("component"))
    for item in sorted_variables:
        print(template.format(
            item[1]["component"],
            item[1]["variable"],
            item[1]["description"],
            item[1]["unit"]))

pyhector.units
--------------

A dictionary with emissions categories and their associated units.

.. exec::
    from pyhector import units
    for key, value in sorted(units.items()):
        print("- ``{}``:  {}\n".format(key, value))
<commit_msg>Fix docs after rename<commit_after>.. automodule:: pyhector
    :members:
    :undoc-members:
    :show-inheritance:

pyhector.constants
------------------

Dictionaries ``components`` and ``variables`` used for mapping categories
internally. Auto-generated from Hector headers.


pyhector.default_config
-----------------------

A dictionary with Hector's default configuration parameters.
See also `the original config file on GitHub <https://github.com/openclimatedata/pyhector/blob/master/pyhector/rcp_default.ini>`_.
In **pyhector** this INI-file is represented as a dictionary.

pyhector.emissions
------------------

A dictionary with mapping from Hector components to emissions used in
the respective component.

.. exec::
    from pyhector import emissions
    sorted_emissions = sorted(emissions.items())
    for item in sorted_emissions:
        print("- ``{}``: {}".format(item[0], item[1]))

pyhector.output
---------------

A dictionary with Hector's available output variables

    output = {
        'C2F6_halocarbon.hc_concentration': {
            'component': 'C2F6_halocarbon',
            'description': 'C2F6 concentration',
            'unit': 'pptv',
            'variable': 'hc_concentration'
        },
        [...]

Full list below, sorted by dictionary key "component.variable", showing
description and the associated unit:

.. exec::
    from pyhector import output
    template = "- ``{}.{}``, {}, {}"
    sorted_output = sorted(output.items(),
                              key=output.get("component"))
    for item in sorted_output:
        print(template.format(
            item[1]["component"],
            item[1]["variable"],
            item[1]["description"],
            item[1]["unit"]))

pyhector.units
--------------

A dictionary with emissions categories and their associated units.

.. exec::
    from pyhector import units
    for key, value in sorted(units.items()):
        print("- ``{}``:  {}\n".format(key, value))

{'fraction_non_alphanumeric': 0.1628614916286149, 'fraction_numerical': 0.0060882800608828, 'mean_word_length': 2.5554553651938683, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3051169', 'n_tokens_mistral': 1099, 'n_tokens_neox': 1080, 'n_words': 301}