Merge branch 'dev' into features/#1067-gas_sanitycheck_eGon100RE

openego · Mar 27, 2023 · c2b32cf · c2b32cf
2 parents 3c4e7bc + aba9f22
commit c2b32cf
Show file tree

Hide file tree

Showing 158 changed files with 2,263 additions and 388 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -488,6 +488,8 @@ Changed
   `#1026 <https://github.com/openego/eGon-data/issues/1026>`_
 * Add sanity checks for gas sector in eGon100RE
   `#1067 <https://github.com/openego/eGon-data/issues/1067>`_
+* Change hgv data source to use database
+  `#1086 <https://github.com/openego/eGon-data/issues/1086>`_
 
 .. _#799: https://github.com/openego/eGon-data/issues/799
 
@@ -726,6 +728,13 @@ Bug Fixes
   Fixes issue `#985`_ via PR `#986`_.
 * Bypass SSL verification
   `#1102 <https://github.com/openego/eGon-data/issues/1102>`_
+* Fix faulty DSM time series
+  `#1088 <https://github.com/openego/eGon-data/issues/1088>`_
+* Set upper limit on commissioning date for units from MaStR
+  dataset
+  `#1098 <https://github.com/openego/eGon-data/issues/1098>`_
+* Fix conversion factor for CH4 loads abroad in eGon2035
+  `#1104 <https://github.com/openego/eGon-data/issues/1104>`_
 
 .. _PR #692: https://github.com/openego/eGon-data/pull/692
 .. _#343: https://github.com/openego/eGon-data/issues/343

diff --git a/docs/_templates/module.rst_t b/docs/_templates/module.rst_t
@@ -0,0 +1,9 @@
+{%- if show_headings %}
+{{- basename.split(".")[-1] | e | heading }}
+
+{% endif -%}
+.. automodule:: {{ qualname }}
+{%- for option in automodule_options %}
+   :{{ option }}:
+{%- endfor %}
+
diff --git a/docs/_templates/package.rst_t b/docs/_templates/package.rst_t
@@ -0,0 +1,47 @@
+{% macro automodule(modname, options) %}
+
+.. automodule:: {{ modname }}
+{%- for option in options %}
+   :{{ option }}:
+{%- endfor %}
+{%- endmacro %}
+
+{% macro toctree(docnames) -%}
+
+.. toctree::
+   :maxdepth: {{ maxdepth }}
+{% for docname in docnames %}
+   {{ docname }}
+{%- endfor %}
+{%- endmacro %}
+
+{{- pkgname.split(".")[-1] | e | heading }}
+
+{%- if is_namespace %}
+
+.. py:module:: {{ pkgname }}
+{% endif %}
+
+{%- if modulefirst and not is_namespace %}
+{{ automodule(pkgname, automodule_options) }}
+{% endif %}
+
+{%- if submodules %}
+{% if separatemodules %}
+{{- toctree(submodules + subpackages) }}
+{% else %}
+{%- if subpackages %}
+{{ toctree(subpackages) }}
+{% endif %}
+{%- for submodule in submodules %}
+{% if show_headings %}
+{{- [submodule, "module"] | join(" ") | e | heading(2) }}
+{% endif %}
+{{ automodule(submodule, automodule_options) }}
+{% endfor %}
+{%- endif %}
+{%- endif %}
+
+{%- if not modulefirst and not is_namespace %}
+{{ automodule(pkgname, automodule_options) }}
+{% endif %}
diff --git a/docs/_templates/toc.rst_t b/docs/_templates/toc.rst_t
@@ -0,0 +1,7 @@
+{{ header | heading }}
+
+.. toctree::
+   :maxdepth: {{ maxdepth }}
+{% for docname in docnames %}
+   {{ docname }}
+{%- endfor %}
diff --git a/docs/conf.py b/docs/conf.py
@@ -44,3 +44,6 @@
 napoleon_use_ivar = True
 napoleon_use_rtype = False
 napoleon_use_param = False
+
+add_module_names = False
+modindex_common_prefix = ["egon.data.", "egon.data.datasets."]
diff --git a/docs/index.rst b/docs/index.rst
@@ -13,7 +13,7 @@ Contents
    contributing
    authors
    changelog
-   Module documentation <reference/index>
+   API Reference: egon.data <reference/egon.data>
 
 Indices and tables
 ==================

diff --git a/docs/reference/egon.data.airflow.dags.pipeline.rst b/docs/reference/egon.data.airflow.dags.pipeline.rst
@@ -1,5 +1,5 @@
-egon.data.airflow.dags.pipeline module
-======================================
+pipeline
+========
 
 .. automodule:: egon.data.airflow.dags.pipeline
    :members:

diff --git a/docs/reference/egon.data.airflow.dags.rst b/docs/reference/egon.data.airflow.dags.rst
@@ -1,13 +1,11 @@
-egon.data.airflow.dags namespace
-================================
 
-Submodules
-----------
 
-egon.data.airflow.dags.pipeline module
---------------------------------------
+dags
+====
 
-.. automodule:: egon.data.airflow.dags.pipeline
-   :members:
-   :undoc-members:
-   :show-inheritance:
+.. py:module:: egon.data.airflow.dags
+
+.. toctree::
+   :maxdepth: 1
+
+   egon.data.airflow.dags.pipeline
diff --git a/docs/reference/egon.data.airflow.rst b/docs/reference/egon.data.airflow.rst
@@ -1,26 +1,10 @@
-egon.data.airflow package
-=========================
 
-.. automodule:: egon.data.airflow
-   :members:
-   :undoc-members:
-   :show-inheritance:
 
-Subpackages
------------
+airflow
+=======
 
-.. toctree::
-   :maxdepth: 4
 
-   egon.data.airflow.dags
-
-Submodules
-----------
-
-egon.data.airflow.tasks module
-------------------------------
-
-.. automodule:: egon.data.airflow.tasks
+.. automodule:: egon.data.airflow
    :members:
    :undoc-members:
    :show-inheritance:
diff --git a/docs/reference/egon.data.airflow.tasks.rst b/docs/reference/egon.data.airflow.tasks.rst
diff --git a/docs/reference/egon.data.cli.rst b/docs/reference/egon.data.cli.rst
@@ -1,5 +1,5 @@
-egon.data.cli module
-====================
+cli
+===
 
 .. automodule:: egon.data.cli
    :members:

diff --git a/docs/reference/egon.data.config.rst b/docs/reference/egon.data.config.rst
@@ -0,0 +1,7 @@
+config
+======
+
+.. automodule:: egon.data.config
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/reference/egon.data.dataset_configuration.rst b/docs/reference/egon.data.dataset_configuration.rst
@@ -0,0 +1,7 @@
+dataset\_configuration
+======================
+
+.. automodule:: egon.data.dataset_configuration
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/reference/egon.data.datasets.DSM_cts_ind.rst b/docs/reference/egon.data.datasets.DSM_cts_ind.rst
@@ -0,0 +1,7 @@
+DSM\_cts\_ind
+=============
+
+.. automodule:: egon.data.datasets.DSM_cts_ind
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/reference/egon.data.datasets.calculate_dlr.rst b/docs/reference/egon.data.datasets.calculate_dlr.rst
@@ -0,0 +1,7 @@
+calculate\_dlr
+==============
+
+.. automodule:: egon.data.datasets.calculate_dlr
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/reference/egon.data.datasets.ch4_prod.rst b/docs/reference/egon.data.datasets.ch4_prod.rst
@@ -0,0 +1,7 @@
+ch4\_prod
+=========
+
+.. automodule:: egon.data.datasets.ch4_prod
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/reference/egon.data.datasets.ch4_storages.rst b/docs/reference/egon.data.datasets.ch4_storages.rst
@@ -0,0 +1,7 @@
+ch4\_storages
+=============
+
+.. automodule:: egon.data.datasets.ch4_storages
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/reference/egon.data.datasets.chp.match_nep.rst b/docs/reference/egon.data.datasets.chp.match_nep.rst
@@ -0,0 +1,7 @@
+match\_nep
+==========
+
+.. automodule:: egon.data.datasets.chp.match_nep
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/reference/egon.data.datasets.chp.rst b/docs/reference/egon.data.datasets.chp.rst
@@ -0,0 +1,16 @@
+
+
+chp
+===
+.. toctree::
+   :maxdepth: 1
+
+   egon.data.datasets.chp.match_nep
+   egon.data.datasets.chp.small_chp
+
+
+
+.. automodule:: egon.data.datasets.chp
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/reference/egon.data.datasets.chp.small_chp.rst b/docs/reference/egon.data.datasets.chp.small_chp.rst
@@ -0,0 +1,7 @@
+small\_chp
+==========
+
+.. automodule:: egon.data.datasets.chp.small_chp
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/reference/egon.data.datasets.chp_etrago.rst b/docs/reference/egon.data.datasets.chp_etrago.rst
@@ -0,0 +1,7 @@
+chp\_etrago
+===========
+
+.. automodule:: egon.data.datasets.chp_etrago
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/reference/egon.data.datasets.data_bundle.rst b/docs/reference/egon.data.datasets.data_bundle.rst
@@ -0,0 +1,10 @@
+
+
+data\_bundle
+============
+
+
+.. automodule:: egon.data.datasets.data_bundle
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/reference/egon.data.datasets.database.rst b/docs/reference/egon.data.datasets.database.rst
@@ -0,0 +1,7 @@
+database
+========
+
+.. automodule:: egon.data.datasets.database
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/reference/egon.data.datasets.demandregio.install_disaggregator.rst b/docs/reference/egon.data.datasets.demandregio.install_disaggregator.rst
@@ -0,0 +1,7 @@
+install\_disaggregator
+======================
+
+.. automodule:: egon.data.datasets.demandregio.install_disaggregator
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/reference/egon.data.datasets.demandregio.rst b/docs/reference/egon.data.datasets.demandregio.rst
@@ -0,0 +1,15 @@
+
+
+demandregio
+===========
+.. toctree::
+   :maxdepth: 1
+
+   egon.data.datasets.demandregio.install_disaggregator
+
+
+
+.. automodule:: egon.data.datasets.demandregio
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/reference/egon.data.datasets.district_heating_areas.plot.rst b/docs/reference/egon.data.datasets.district_heating_areas.plot.rst
@@ -0,0 +1,7 @@
+plot
+====
+
+.. automodule:: egon.data.datasets.district_heating_areas.plot
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/reference/egon.data.datasets.district_heating_areas.rst b/docs/reference/egon.data.datasets.district_heating_areas.rst
@@ -0,0 +1,15 @@
+
+
+district\_heating\_areas
+========================
+.. toctree::
+   :maxdepth: 1
+
+   egon.data.datasets.district_heating_areas.plot
+
+
+
+.. automodule:: egon.data.datasets.district_heating_areas
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/reference/egon.data.datasets.electrical_neighbours.rst b/docs/reference/egon.data.datasets.electrical_neighbours.rst
@@ -0,0 +1,7 @@
+electrical\_neighbours
+======================
+
+.. automodule:: egon.data.datasets.electrical_neighbours
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/reference/egon.data.datasets.electricity_demand.rst b/docs/reference/egon.data.datasets.electricity_demand.rst
@@ -0,0 +1,15 @@
+
+
+electricity\_demand
+===================
+.. toctree::
+   :maxdepth: 1
+
+   egon.data.datasets.electricity_demand.temporal
+
+
+
+.. automodule:: egon.data.datasets.electricity_demand
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/reference/egon.data.datasets.electricity_demand.temporal.rst b/docs/reference/egon.data.datasets.electricity_demand.temporal.rst
@@ -0,0 +1,7 @@
+temporal
+========
+
+.. automodule:: egon.data.datasets.electricity_demand.temporal
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/reference/egon.data.datasets.electricity_demand_etrago.rst b/docs/reference/egon.data.datasets.electricity_demand_etrago.rst
@@ -0,0 +1,7 @@
+electricity\_demand\_etrago
+===========================
+
+.. automodule:: egon.data.datasets.electricity_demand_etrago
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/reference/egon.data.datasets.electricity_demand_timeseries.cts_buildings.rst b/docs/reference/egon.data.datasets.electricity_demand_timeseries.cts_buildings.rst
@@ -0,0 +1,7 @@
+cts\_buildings
+==============
+
+.. automodule:: egon.data.datasets.electricity_demand_timeseries.cts_buildings
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/reference/egon.data.datasets.electricity_demand_timeseries.hh_buildings.rst b/docs/reference/egon.data.datasets.electricity_demand_timeseries.hh_buildings.rst
@@ -0,0 +1,7 @@
+hh\_buildings
+=============
+
+.. automodule:: egon.data.datasets.electricity_demand_timeseries.hh_buildings
+   :members:
+   :undoc-members:
+   :show-inheritance: