Merge pull request #28 from GermanZero-de/workOnReadMe

Work on read me

.gitignore

@@ -0,0 +1 @@
+.vscode/

ags/README.rst

@@ -1,5 +1,5 @@
 AGS Master and KE list
-===============
+=======================
 
 The keteamsList.csv list includes all active, currently inactive and befriended KE teams (German: KE - Klimaentscheid) according to https://mitmachen-wiki.germanzero.org/wiki/index.php?title=Klimaentscheide:Klimaentscheid-Teams
 

area/README.rst

@@ -1,7 +1,24 @@
-Area
-=====
+Area Data
+=========
+Data provided by Statistische Ämter des Bundes und der Länder, Deutschland.
+Data Overview: https://www-genesis.destatis.de/genesis/online?sequenz=statistikTabellen&selectionname=33111#abreadcrumb
 
-TODO: Add URL where we got the data from.
+(To get data on the communal level you need to create an account and log in!)
+
+- land_total -> Gesamtfläche (*from Bodenflächen*)
+- land_settlement -> Siedlungsfläche (*from Bodenflächen*)
+- land_traffic -> Verkehrsfläche (*from Bodenflächen*)
+- veg_agri -> Vegetationsfläche Landwirtschaft (*from Bodenflächen*)
+- veg_forrest -> Vegetationsfläche Wald (*from Bodenflächen*)
+- veg_wood -> Vegetationsfläche Gehölz (*from Bodenflächen*)
+- veg_heath -> Vegetationsfläche Heide (*from Bodenflächen*)
+- veg_moor -> Vegetationsfläche Moor (*from Bodenflächen*)
+- veg_marsh -> Vegetationsfläche Sumpf (*from Bodenflächen*)
+- veg_plant_uncover_com -> Vegetationsfläche Unland, Vegetationslose Fläche (*from Bodenflächen*)
+- water_total -> Gewässerfläche Gesamt (*from Bodenflächen*)
+- settlement_ghd -> Industrie- und Gewerbefläche, Industrie und Gewerbe	(*from Siedlungsflächen*)
+
+*Bodenflächen* und *Siedlungsflächen* extracted from there.
 
 © Statistische Ämter des Bundes und der Länder, Deutschland, 2020.	
 Dieses Werk ist lizenziert unter der Datenlizenz Deutschland	
@@ -15,7 +32,9 @@ incorporated two ags changes, that were not included in the area list:
  - Eifelkreis BitburgPrüm (07232000) - Sum (07223XXX) -> Brimmingen (07232502)
 
 11.03.2022:
-~~~~~~~~~~
+~~~~~~~~~~~
+
+
 Added missing land_total areas from destatis Data 
  - Stapel (01059188) add land total = 3267
  - Brodersby-Goltoft (01059189) add land total = 1345

area_kinds/README.rst

@@ -1,4 +1,29 @@
 Area kinds
 ==========
+Area kinds provide a method to categorize communities by type (and then deal with them differently in the LocalZero calculation).
+The Area kinds-table is only used in the transport sector. There are different categorization keys.
+A more detailed explanation of the RegioStar can be found under https://www.bmvi.de/SharedDocs/DE/Anlage/G/regiostar-raumtypologie.pdf?__blob=publicationFile
+We use the RegioStar7 (rt7 in the .csv) by the 
+bmvi (Bundesministerium für Verkehr und digitale Infrastruktur) that categorizes into:
+
+- **71**: Metropole - Stadtregion
+- **72**: Regiopolen und Großstädte - Stadtregion
+- **73**: Mittelstädte, städtischer Raum - Stadtregion
+- **74**: Kleinstädtischer, dörflicher Raum - Stadtregion
+- **75**: Zentrale Städte - ländliche Region
+- **76**: Mittelstädte, städtischer Raum - ländliche Region
+- **77**: Kleinstädtischer, dörflicher Raum - ländliche Region
+
+The RegioStar7 is used in the transport 2018 calculation script and can be found under https://www.bmvi.de/SharedDocs/DE/Artikel/G/regionalstatistische-raumtypologie.html.
+
+The Area kind categorization key also originates in the RegioStar7 key and categorizes into 3 categories:
+
+- city (Stadt)        71,72
+- smcty (Halbstadt)   73,75
+- rural (Land)        74,76,77
+
+This key is used in the transport 203X sector. The translation is taken from the "Klimaneutrales Deutschland" Study by agora-energiewende (Page 87, Table 3):
+https://www.agora-energiewende.de/veroeffentlichungen/klimaneutrales-deutschland/
+
+
 
-TODO: Where did we get this data from...

assumptions/README.rst

@@ -0,0 +1,17 @@
+Assumptions Table
+=================
+
+This table holds many single assumptions we assumed and used while developing our model. Most of them originate from studies that provide models of the future of Germany.
+See more information for each individual assumption directly in the table. 
+
+ - label -> *the label we used in our code*
+ - group -> *this provides info on how this assumption is used in our code*
+ 	- ud -> *used directly*
+ 	- ui -> *used indirectly (meaning this assumption is not used in the code but used to calculate another one that is ud)*
+ 	- ufyi -> *for your interest (some assumptions/facts that are nice to know and might become useful later, when we improve out model)* 
+ - description -> *description of the assumption*
+ - value -> *value of the assumption*
+ - unit -> *unit of the assumption (not available for some assumptions)*
+ - rationale -> *a more detailed description*
+ - reference -> *reference*
+ - link -> *link to the reference*

buildings/README.rst

@@ -1,10 +1,10 @@
 Buildings
+=========
 
-The buildings list originates in the Gebäudezensus 2011/2012. Manual changes were made to update the list to 2018 by Thomas Strauss and Manfred Schüssler.
 
-TODO URL + Doku 
+The buildings list originates in the Gebäudezensus 2011/2012. Manual changes were made to update the list to 2018 by Sascha Pfaffmann and Manfred Schüssler.
 
-=========
+https://www.zensus2011.de/DE/Home/Aktuelles/DemografischeGrunddaten.html -> Gebäude und Wohnungen
 
 Changes Leon und Hauke 11.02.2022
 

co2path/README.rst

@@ -0,0 +1,15 @@
+CO2 Path Data
+=============
+
+This is contains data that are calculated and moddeled by us. We will add more information here later.
+#TODO
+
+- CH4_limit_per_year
+- CH4_budget_2016_to_year
+- N2O_limit_per_year
+- N2O_budget_2016_to_year
+- Fgases_limit_per_year
+- Fgases_budget_2016_to_year
+- nonCO2_limit_per_year
+- nonCO2_budget_2016_to_year
+- GHG_budget_2016_to_year

destatis/README.rst

@@ -1,7 +1,7 @@
 Destatis Traffic Data
 =====================
 
-Quelle: Destatis  "Verkehr:  Personenverkehr mit Bussen und Bahnen" (2018) - 1.10   
+Source: Destatis  "Verkehr:  Personenverkehr mit Bussen und Bahnen" (2018) - 1.10   
 Fahrleistungen im Schienen- und Liniennahverkehr nach Art des Verkehrsmittels und Kreisen  S. 27-31
 
 
@@ -13,8 +13,12 @@ Die Daten werden jährlich bei allen Großunternehmen mit mindestens 250 000 Fa
 Stichprobenunternehmen mit weniger als 250 000 Fahrgästen erhoben. Die Angaben im Linienennahverkehr
 zur Fahrleistung beziehen sich auf den Kreis der tatsächlichen Leistungserbringung (NUTS 3-Ebene).
 
-Contains "Insgesamt [Mio. Fahrzeug-km]"	"Eisenbahn [Mio. Fz-km]"	"SSU-Bahn [Mio. Fz-km]"	"Omnibus [Mio. Fz-km]"
-for all Landkreise (XXXXX000)
+Data:
+- total_mega_km -> Insgesamt [Mio. Fahrzeug-km]
+- rail_mega_km -> Eisenbahn [Mio. Fz-km]
+- metro_mega_km -> SSU-Bahn [Mio. Fz-km]
+- bus_mega_km -> Omnibus [Mio. Fz-km]
+
 
 
 Changes GermanZero:

facts/README.rst

@@ -0,0 +1,17 @@
+Facts Table
+===========
+
+This table holds many single facts we used while developing our model. Most of them originate from studies or other soruces.
+See more information for each individual fact directly in the table. 
+
+ - label -> *the label we used in our code*
+ - group -> *this provides info on how this fact is used in our code*
+ 	- ud -> *used directly*
+ 	- ui -> *used indirectly (meaning this fact is not used in the code but used to calculate another one that is ud)*
+ 	- ufyi -> *for your interest (some facts that are nice to know and might become useful later, when we improve out model)* 
+ - description -> *description of the fact*
+ - value -> *value of the fact*
+ - unit -> *unit of the fact (not available for some facts)*
+ - rationale -> *a more detailed description*
+ - reference -> *reference*
+ - link -> *link to the reference*

flats/README.rst

@@ -0,0 +1,7 @@
+Flats Data
+==========
+
+The flats list originates in the Gebäudezensus 2011/2012. Manual changes were made to update the list to 2018 by Sascha Pfaffmann and Manfred Schüssler.
+
+https://www.zensus2011.de/DE/Home/Aktuelles/DemografischeGrunddaten.html -> Gebäude und Wohnungen
+

nat_agri/README.rst

@@ -3,7 +3,8 @@ Nat_Agri List
 
 This list contains only AGS values on the state level (Bundesländer) and the national AGS (DG000000). The data was originally published by the Thünen-Institute in the Thünen Report 77. 
 
--> TODO: paste URL and specify Tables
+TODO: paste URL and specify Tables
+We will add more information here later.
 
 Changes by GermanZero
 ---------------------

nat_energy/README.rst

@@ -0,0 +1,4 @@
+nat energy data
+===============
+
+We will add more information here later.

nat_organic_agri/README.rst

@@ -0,0 +1,4 @@
+nat organic agri data
+=====================
+
+We will add more information here later.

nat_res_buildings/README.rst

@@ -0,0 +1,8 @@
+communal buildings Data
+=======================
+
+This table provides information on flats owned by the communes or communal companies the individual states. 
+The date is extracted from table 6 page 33 (*column "Kommune oder kommunales Wohnungsunternehmen"*)
+https://www.statistik.rlp.de/fileadmin/dokumente/gemeinschaftsveroeff/zen/Zensus_GWZ_2014.pdf
+
+in the "Gebäude- und Wohnungsbestand in Deutschland" report published by "statistische Ämter des Bundes und der Länder" in 2011.

population/README.rst

@@ -1,8 +1,10 @@
-Population
+Population Data
 ===============
 
 The 2018.csv contains the population for all states, districts and cities of Germany as well as its total population by the record date 31.12.2018.
-The original list for 2018 needs to be requested from destatis, the Federal Statistical office. The list for the current year can be found here: https://www.destatis.de/DE/Themen/Laender-Regionen/Regionales/Gemeindeverzeichnis/_inhalt.html
-
-
+The original list for 2018 needs to be requested from destatis, the Federal Statistical office. The list for the current year can be found here: 
+https://www.destatis.de/DE/Themen/Laender-Regionen/Regionales/Gemeindeverzeichnis/_inhalt.html
+(See Archiv -> Regionale Gliederung -> Jahresausgaben -> 31.12.2018)
 
+- ags -> amtlicher Gemeindeschlüssel (*constructed from the ARS without the "VB"*)
+- total -> population (*Bevölkerung insgesamt column*)

renewable_energy/README.rst

@@ -0,0 +1,17 @@
+Renewable Energy Data
+=====================
+
+This data originates in the "Marktstammdatenregister" (https://www.marktstammdatenregister.de/MaStR/Einheit/Einheiten/OeffentlicheEinheitenuebersicht). This list
+contains all registered and installed renewable energy producers (single solar cells, wind turbines etc.) and provides information on the current status, the units
+power, the date of installation etc. It also provides the location or more precisely the name of the city/village/town and the "Postleitzahl", where the unit is located.
+This allows us to sum over all units within one commune and calculate the locally installed renewable power grouped by 
+
+- pv (power of local photo voltaic cells)
+- wind_on (power of local onshore wind turbines)
+- biomass (power of local biomas power plants)
+- geothermal (power of local geothermal sources)
+- water (power of local water power plants)
+
+This summation and bucketing to all ags keys was done in excel and needs to be repeated in python soon as the we choose an ags ist for 2021 instead of 2018 
+(We will provide a script as soon as this is done.).
+Therefore all ags keys from 2018 that had changes after 2018 are not part of the list right now. Only their ags successors are conatined at the moment.