Merge pull request #21 from calliope-project/fix-hydropower-docs

Fix documentation and license file omissions

AUTHORS

@@ -6,4 +6,7 @@ This does not necessarily list everyone who has contributed to ec_modules
 code or documentation. For a full contributor list, see:
 <https://github.com/calliope-project/ec_modules/graphs/contributors>
 
-Ivan Ruiz Manuel, TU Delft <[email protected]>
+- Ivan Ruiz Manuel, TU Delft <[email protected]>
+- Stefan Pfenninger-Lee, TU Delft <[email protected]>
+- Francesco Sanvito, TU Delft <[email protected]>
+- Meijun Chen, TU Delft <[email protected]>

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Calliope
+Copyright (c) 2024 AUTHORS
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

modules/heat/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018-2021 Tim Tröndle (ETH Zürich / IASS Potsdam), Bryn Pickering (ETH Zürich)
+Copyright (c) 2018-2023 Bryn Pickering (ETH Zürich)
 Copyright (c) 2024 AUTHORS
 
 Permission is hereby granted, free of charge, to any person obtaining a copy

modules/hydropower/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2018-2023 Tim Tröndle (ETH Zürich / IASS Potsdam), Bryn Pickering (ETH Zürich)
+Copyright (c) 2024 AUTHORS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

modules/hydropower/README.md

@@ -1,6 +1,12 @@
-# Easy Hydropower data
+# Module: Hydropower
 
-Generate timeseries for hydropower plants in Europe.
+A module to estimate hydropower capacity factors and powerplant capacities for arbitrary regions in Europe.
+
+## Input-Output
+
+Here is a brief summary of the IO structure of the module.
+
+Users must specify a remote location of shapefile with the desired subregions in the configuration, which will be downloaded and processed into timeseries and capacity values by the module.
 
 ```mermaid
 flowchart LR
@@ -11,3 +17,10 @@ flowchart LR
     M --> O3(region-power-capacity.csv)
     M --> O4(region-storage-capacity.csv)
 ```
+
+## DAG
+
+Here is a brief overview of the module's steps.
+Please consult the code for more details.
+
+![dag](rulegraph.png)

modules/transport_road/LICENSE

@@ -1,6 +1,7 @@
 MIT License
 
-Copyright (c) 2021, Francesco Sanvito (TU Delft), Bryn Pickering (University of Cambridge), Adrien Mellot (ETH Zürich), Ivan Ruiz Manuel (TU Delft)
+Copyright (c) 2021-2023 Bryn Pickering (ETH Zürich)
+Copyright (c) 2024 AUTHORS and Adrien Mellot (ETH Zürich)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

modules/transport_road/README.md

@@ -6,4 +6,24 @@ A module to create transport demand for European Energy Models.
 >For now, only electrified transport is fully supported.
 >In the future, this module will instead follow a VKM approach that is more flexible.
 
+## Input-Output
+
+Here is a brief summary of the IO structure of the module.
+
+Users must specify a remote location of shapefile with the desired subregions in the configuration, which will be downloaded and processed into timeseries and capacity values by the module.
+
+```mermaid
+flowchart LR
+    I1(shapefile.geojson) -.-> |Download| C
+    C(config.yaml) -->M((transport-road))
+    M --> O1(annual-charging-demand.csv)
+    M --> O2("controlled-ev-charging-timeseries.csv
+    uncontrolled-ev-charging-timeseries.csv")
+```
+
+## DAG
+
+Here is a brief overview of the module's steps.
+Please consult the code for more details.
+
 ![dag](rulegraph.png)