Merge pull request #646 from PyPSA/fix-docformatter

pre-commit: update docformatter version
PyPSA · Apr 21, 2023 · 3cc3e06 · 3cc3e06
2 parents 2baacfa + 5c8e008
commit 3cc3e06
Show file tree

Hide file tree

Showing 44 changed files with 2 additions and 45 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -39,7 +39,7 @@ repos:
 
   # Make docstrings PEP 257 compliant
 - repo: https://github.com/PyCQA/docformatter
-  rev: v1.6.0
+  rev: v1.6.1-rc1
   hooks:
   - id: docformatter
     args: ["--in-place", "--make-summary-multi-line", "--pre-summary-newline"]

diff --git a/scripts/add_brownfield.py b/scripts/add_brownfield.py
@@ -2,7 +2,6 @@
 # SPDX-FileCopyrightText: : 2020-2023 The PyPSA-Eur Authors
 #
 # SPDX-License-Identifier: MIT
-
 """
 Prepares brownfield data from previous planning horizon.
 """

diff --git a/scripts/add_existing_baseyear.py b/scripts/add_existing_baseyear.py
@@ -2,7 +2,6 @@
 # SPDX-FileCopyrightText: : 2020-2023 The PyPSA-Eur Authors
 #
 # SPDX-License-Identifier: MIT
-
 """
 Adds existing power and heat generation capacities for initial planning
 horizon.

diff --git a/scripts/build_biomass_transport_costs.py b/scripts/build_biomass_transport_costs.py
@@ -2,7 +2,6 @@
 # SPDX-FileCopyrightText: : 2020-2023 The PyPSA-Eur Authors
 #
 # SPDX-License-Identifier: MIT
-
 """
 Reads biomass transport costs for different countries of the JRC report.
 

diff --git a/scripts/build_bus_regions.py b/scripts/build_bus_regions.py
@@ -2,7 +2,6 @@
 # SPDX-FileCopyrightText: : 2017-2023 The PyPSA-Eur Authors
 #
 # SPDX-License-Identifier: MIT
-
 """
 Creates Voronoi shapes for each bus representing both onshore and offshore
 regions.

diff --git a/scripts/build_clustered_population_layouts.py b/scripts/build_clustered_population_layouts.py
@@ -2,7 +2,6 @@
 # SPDX-FileCopyrightText: : 2020-2023 The PyPSA-Eur Authors
 #
 # SPDX-License-Identifier: MIT
-
 """
 Build population layouts for all clustered model regions as total as well as
 split by urban and rural population.

diff --git a/scripts/build_cop_profiles.py b/scripts/build_cop_profiles.py
@@ -2,7 +2,6 @@
 # SPDX-FileCopyrightText: : 2020-2023 The PyPSA-Eur Authors
 #
 # SPDX-License-Identifier: MIT
-
 """
 Build coefficient of performance (COP) time series for air- or ground-sourced
 heat pumps.

diff --git a/scripts/build_cutout.py b/scripts/build_cutout.py
@@ -2,7 +2,6 @@
 # SPDX-FileCopyrightText: : 2017-2023 The PyPSA-Eur Authors
 #
 # SPDX-License-Identifier: MIT
-
 """
 Create cutouts with `atlite <https://atlite.readthedocs.io/en/latest/>`_.
 

diff --git a/scripts/build_electricity_demand.py b/scripts/build_electricity_demand.py
@@ -2,7 +2,6 @@
 # SPDX-FileCopyrightText: : 2020 @JanFrederickUnnewehr, The PyPSA-Eur Authors
 #
 # SPDX-License-Identifier: MIT
-
 """
 This rule downloads the load data from `Open Power System Data Time series.
 

diff --git a/scripts/build_energy_totals.py b/scripts/build_energy_totals.py
@@ -2,7 +2,6 @@
 # SPDX-FileCopyrightText: : 2020-2023 The PyPSA-Eur Authors
 #
 # SPDX-License-Identifier: MIT
-
 """
 Build total energy demands per country using JRC IDEES, eurostat, and EEA data.
 """

diff --git a/scripts/build_gas_input_locations.py b/scripts/build_gas_input_locations.py
@@ -2,7 +2,6 @@
 # SPDX-FileCopyrightText: : 2021-2023 The PyPSA-Eur Authors
 #
 # SPDX-License-Identifier: MIT
-
 """
 Build import locations for fossil gas from entry-points, LNG terminals and
 production sites with data from SciGRID_gas and Global Energy Monitor.

diff --git a/scripts/build_gas_network.py b/scripts/build_gas_network.py
@@ -2,7 +2,6 @@
 # SPDX-FileCopyrightText: : 2020-2023 The PyPSA-Eur Authors
 #
 # SPDX-License-Identifier: MIT
-
 """
 Preprocess gas network based on data from bthe SciGRID_gas project
 (https://www.gas.scigrid.de/).

diff --git a/scripts/build_heat_demand.py b/scripts/build_heat_demand.py
@@ -2,7 +2,6 @@
 # SPDX-FileCopyrightText: : 2020-2023 The PyPSA-Eur Authors
 #
 # SPDX-License-Identifier: MIT
-
 """
 Build heat demand time series using heating degree day (HDD) approximation.
 """

diff --git a/scripts/build_hydro_profile.py b/scripts/build_hydro_profile.py
@@ -4,7 +4,6 @@
 # SPDX-FileCopyrightText: : 2017-2023 The PyPSA-Eur Authors
 #
 # SPDX-License-Identifier: MIT
-
 """
 Build hydroelectric inflow time-series for each country.
 

diff --git a/scripts/build_industrial_distribution_key.py b/scripts/build_industrial_distribution_key.py
@@ -2,7 +2,6 @@
 # SPDX-FileCopyrightText: : 2020-2023 The PyPSA-Eur Authors
 #
 # SPDX-License-Identifier: MIT
-
 """
 Build spatial distribution of industries from Hotmaps database.
 """

diff --git a/scripts/build_industrial_energy_demand_per_country_today.py b/scripts/build_industrial_energy_demand_per_country_today.py
@@ -2,7 +2,6 @@
 # SPDX-FileCopyrightText: : 2020-2023 The PyPSA-Eur Authors
 #
 # SPDX-License-Identifier: MIT
-
 """
 Build industrial energy demand per country.
 """

diff --git a/scripts/build_industrial_energy_demand_per_node.py b/scripts/build_industrial_energy_demand_per_node.py
@@ -2,7 +2,6 @@
 # SPDX-FileCopyrightText: : 2020-2023 The PyPSA-Eur Authors
 #
 # SPDX-License-Identifier: MIT
-
 """
 Build industrial energy demand per model region.
 """

diff --git a/scripts/build_industrial_energy_demand_per_node_today.py b/scripts/build_industrial_energy_demand_per_node_today.py
@@ -2,7 +2,6 @@
 # SPDX-FileCopyrightText: : 2020-2023 The PyPSA-Eur Authors
 #
 # SPDX-License-Identifier: MIT
-
 """
 Build industrial energy demand per model region.
 """

diff --git a/scripts/build_industrial_production_per_country.py b/scripts/build_industrial_production_per_country.py
@@ -2,7 +2,6 @@
 # SPDX-FileCopyrightText: : 2020-2023 The PyPSA-Eur Authors
 #
 # SPDX-License-Identifier: MIT
-
 """
 Build industrial production per country.
 """

diff --git a/scripts/build_industrial_production_per_country_tomorrow.py b/scripts/build_industrial_production_per_country_tomorrow.py
@@ -2,7 +2,6 @@
 # SPDX-FileCopyrightText: : 2020-2023 The PyPSA-Eur Authors
 #
 # SPDX-License-Identifier: MIT
-
 """
 Build future industrial production per country.
 """

diff --git a/scripts/build_industrial_production_per_node.py b/scripts/build_industrial_production_per_node.py
@@ -2,7 +2,6 @@
 # SPDX-FileCopyrightText: : 2020-2023 The PyPSA-Eur Authors
 #
 # SPDX-License-Identifier: MIT
-
 """
 Build industrial production per model region.
 """

diff --git a/scripts/build_industry_sector_ratios.py b/scripts/build_industry_sector_ratios.py
@@ -2,7 +2,6 @@
 # SPDX-FileCopyrightText: : 2020-2023 The PyPSA-Eur Authors
 #
 # SPDX-License-Identifier: MIT
-
 """
 Build specific energy consumption by carrier and industries.
 """

diff --git a/scripts/build_natura_raster.py b/scripts/build_natura_raster.py
@@ -2,7 +2,6 @@
 # SPDX-FileCopyrightText: : 2017-2023 The PyPSA-Eur Authors
 #
 # SPDX-License-Identifier: MIT
-
 """
 Rasters the vector data of the `Natura 2000.
 

diff --git a/scripts/build_population_layouts.py b/scripts/build_population_layouts.py
@@ -2,7 +2,6 @@
 # SPDX-FileCopyrightText: : 2020-2023 The PyPSA-Eur Authors
 #
 # SPDX-License-Identifier: MIT
-
 """
 Build mapping between cutout grid cells and population (total, urban, rural).
 """

diff --git a/scripts/build_population_weighted_energy_totals.py b/scripts/build_population_weighted_energy_totals.py
@@ -2,7 +2,6 @@
 # SPDX-FileCopyrightText: : 2020-2023 The PyPSA-Eur Authors
 #
 # SPDX-License-Identifier: MIT
-
 """
 Distribute country-level energy demands by population.
 """

diff --git a/scripts/build_renewable_profiles.py b/scripts/build_renewable_profiles.py
@@ -4,7 +4,6 @@
 # SPDX-FileCopyrightText: : 2017-2023 The PyPSA-Eur Authors
 #
 # SPDX-License-Identifier: MIT
-
 """
 Calculates for each network node the (i) installable capacity (based on land-
 use), (ii) the available generation time series (based on weather data), and

diff --git a/scripts/build_retro_cost.py b/scripts/build_retro_cost.py
@@ -3,7 +3,6 @@
 # SPDX-FileCopyrightText: : 2020-2023 The PyPSA-Eur Authors
 #
 # SPDX-License-Identifier: MIT
-
 """
 This script calculates the space heating savings through better insulation of
 the thermal envelope of a building and corresponding costs for different

diff --git a/scripts/build_salt_cavern_potentials.py b/scripts/build_salt_cavern_potentials.py
@@ -2,7 +2,6 @@
 # SPDX-FileCopyrightText: : 2020-2023 The PyPSA-Eur Authors
 #
 # SPDX-License-Identifier: MIT
-
 """
 Build salt cavern potentials for hydrogen storage.
 

diff --git a/scripts/build_sequestration_potentials.py b/scripts/build_sequestration_potentials.py
@@ -2,7 +2,6 @@
 # SPDX-FileCopyrightText: : 2023 The PyPSA-Eur Authors
 #
 # SPDX-License-Identifier: MIT
-
 """
 Build regionalised geological sequestration potential for carbon dioxide using
 data from `CO2Stop <https://setis.ec.europa.eu/european-co2-storage-

diff --git a/scripts/build_shapes.py b/scripts/build_shapes.py
@@ -2,7 +2,6 @@
 # SPDX-FileCopyrightText: : 2017-2023 The PyPSA-Eur Authors
 #
 # SPDX-License-Identifier: MIT
-
 """
 Creates GIS shape files of the countries, exclusive economic zones and `NUTS3 <
 https://en.wikipedia.org/wiki/Nomenclature_of_Territorial_Units_for_Statistics>

diff --git a/scripts/build_ship_raster.py b/scripts/build_ship_raster.py
@@ -2,7 +2,6 @@
 # SPDX-FileCopyrightText: : 2022 The PyPSA-Eur Authors
 #
 # SPDX-License-Identifier: MIT
-
 """
 Transforms the global ship density data from the `World Bank Data Catalogue.
 

diff --git a/scripts/build_solar_thermal_profiles.py b/scripts/build_solar_thermal_profiles.py
@@ -2,7 +2,6 @@
 # SPDX-FileCopyrightText: : 2020-2023 The PyPSA-Eur Authors
 #
 # SPDX-License-Identifier: MIT
-
 """
 Build solar thermal collector time series.
 """

diff --git a/scripts/build_temperature_profiles.py b/scripts/build_temperature_profiles.py
@@ -2,7 +2,6 @@
 # SPDX-FileCopyrightText: : 2020-2023 The PyPSA-Eur Authors
 #
 # SPDX-License-Identifier: MIT
-
 """
 Build time series for air and soil temperatures per clustered model region.
 """

diff --git a/scripts/build_transport_demand.py b/scripts/build_transport_demand.py
@@ -2,7 +2,6 @@
 # SPDX-FileCopyrightText: : 2020-2023 The PyPSA-Eur Authors
 #
 # SPDX-License-Identifier: MIT
-
 """
 Build land transport demand per clustered model region including efficiency
 improvements due to drivetrain changes, time series for electric vehicle

diff --git a/scripts/cluster_gas_network.py b/scripts/cluster_gas_network.py
@@ -2,7 +2,6 @@
 # SPDX-FileCopyrightText: : 2020-2023 The PyPSA-Eur Authors
 #
 # SPDX-License-Identifier: MIT
-
 """
 Cluster gas transmission network to clustered model regions.
 """

diff --git a/scripts/copy_config.py b/scripts/copy_config.py
@@ -2,7 +2,6 @@
 # SPDX-FileCopyrightText: : 2020-2023 The PyPSA-Eur Authors
 #
 # SPDX-License-Identifier: MIT
-
 """
 Copy used configuration files and important scripts for archiving.
 """

diff --git a/scripts/make_summary.py b/scripts/make_summary.py
@@ -2,7 +2,6 @@
 # SPDX-FileCopyrightText: : 2020-2023 The PyPSA-Eur Authors
 #
 # SPDX-License-Identifier: MIT
-
 """
 Create summary CSV files for all scenario runs including costs, capacities,
 capacity factors, curtailment, energy balances, prices and other metrics.

diff --git a/scripts/plot_network.py b/scripts/plot_network.py
@@ -2,7 +2,6 @@
 # SPDX-FileCopyrightText: : 2020-2023 The PyPSA-Eur Authors
 #
 # SPDX-License-Identifier: MIT
-
 """
 Creates plots for optimised network topologies, including electricity, gas and
 hydrogen networks, and regional generation, storage and conversion capacities

diff --git a/scripts/plot_summary.py b/scripts/plot_summary.py
@@ -2,7 +2,6 @@
 # SPDX-FileCopyrightText: : 2020-2023 The PyPSA-Eur Authors
 #
 # SPDX-License-Identifier: MIT
-
 """
 Creates plots from summary CSV files.
 """

diff --git a/scripts/prepare_links_p_nom.py b/scripts/prepare_links_p_nom.py
@@ -4,7 +4,6 @@
 # SPDX-FileCopyrightText: : 2017-2023 The PyPSA-Eur Authors
 #
 # SPDX-License-Identifier: MIT
-
 """
 Extracts capacities of HVDC links from `Wikipedia.
 

diff --git a/scripts/prepare_sector_network.py b/scripts/prepare_sector_network.py
@@ -2,7 +2,6 @@
 # SPDX-FileCopyrightText: : 2020-2023 The PyPSA-Eur Authors
 #
 # SPDX-License-Identifier: MIT
-
 """
 Adds all sector-coupling components to the network, including demand and supply
 technologies for the buildings, transport and industry sectors.

diff --git a/scripts/retrieve_databundle.py b/scripts/retrieve_databundle.py
@@ -3,7 +3,6 @@
 # SPDX-FileCopyrightText: : 2017-2023 The PyPSA-Eur Authors
 #
 # SPDX-License-Identifier: MIT
-
 """
 .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3517935.svg
    :target: https://doi.org/10.5281/zenodo.3517935

diff --git a/scripts/solve_network.py b/scripts/solve_network.py
@@ -2,7 +2,6 @@
 # SPDX-FileCopyrightText: : 2017-2023 The PyPSA-Eur Authors
 #
 # SPDX-License-Identifier: MIT
-
 """
 Solves optimal operation and capacity for a network with the option to
 iteratively optimize while updating line reactances.
@@ -444,7 +443,7 @@ def add_operational_reserve_margin(n, sns, config):
 
     n.model.add_constraints(lhs >= rhs, name="reserve_margin")
 
-    # additional contraint that capacity is not exceeded
+    # additional constraint that capacity is not exceeded
     gen_i = n.generators.index
     ext_i = n.generators.query("p_nom_extendable").index
     fix_i = n.generators.query("not p_nom_extendable").index

diff --git a/scripts/solve_operations_network.py b/scripts/solve_operations_network.py
@@ -2,7 +2,6 @@
 # SPDX-FileCopyrightText: : 2017-2023 The PyPSA-Eur Authors
 #
 # SPDX-License-Identifier: MIT
-
 """
 Solves linear optimal dispatch in hourly resolution using the capacities of
 previous capacity expansion in rule :mod:`solve_network`.
-Original file line number
+Diff line change
@@ Expand Up / @@ -2,7 +2,6 @@ @@
     # SPDX-FileCopyrightText: : 2020-2023 The PyPSA-Eur Authors
     #
     # SPDX-License-Identifier: MIT
     """
     Prepares brownfield data from previous planning horizon.
     """
@@ Expand Down @@