Moved source files and docs around

Mathias157 · Sep 23, 2024 · fc13f4b · fc13f4b
1 parent 364a9a8
commit fc13f4b
Show file tree

Hide file tree

Showing 42 changed files with 13 additions and 10 deletions.
diff --git a/.github/workflows/sphinx.yml b/.github/workflows/sphinx.yml
@@ -19,15 +19,15 @@ jobs:
     - uses: mamba-org/setup-micromamba@v1
       with:
         micromamba-version: '1.5.8-0' # any version from https://github.com/mamba-org/micromamba-releases
-        environment-file: RawDataProcessing/docs/docs_environment.yml
+        environment-file: docs/docs_environment.yml
         init-shell: bash
         cache-environment: true
         post-cleanup: 'all'
         generate-run-shell: false
 
     - name: Sphinx build
       run: |
-        sphinx-build 'RawDataProcessing/docs' _build
+        sphinx-build 'docs' _build
       shell: bash -el {0}
 
     - name: Deploy to GitHub Pages

diff --git a/.gitignore b/.gitignore
@@ -1,7 +1,7 @@
-RawDataProcessing/Data/*
-RawDataProcessing/Output/*
-!RawDataProcessing/Data/IncFilePreSuf/README.md
-!RawDataProcessing/Output/Figures/.keepoutfolder
+src/Data/*
+src/Output/*
+!src/Data/IncFilePreSuf/README.md
+!src/Output/Figures/.keepoutfolder
 exo_elec_dem_conversion_dictionaries.pkl
 exo_heat_dem_conversion_dictionaries.pkl
 .snakemake

diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,3 @@
+{ 
+    "terminal.integrated.cwd": "src",
+}
diff --git a/README.md b/README.md
@@ -1,9 +1,9 @@
 # Balmorel Pre-Processing
 
-These scripts process raw data into Balmorel input. An application presented at the EGU24 conference is illustrated in the poster below (check Zenodo link below for a high-res pdf). For more info, read README in the RawDataProcessing folder.
+These scripts process raw data into Balmorel input. An application presented at the EGU24 conference is illustrated in the poster below (check Zenodo link below for a high-res pdf). For more info, read README in the src folder.
 ![Application example](https://github.com/Mathias157/balmorel-preprocessing/blob/master/Raw%20Data%20Processing/Conference%20Poster%20for%20Analysis%20of%20Spatial%20Resolutions%20for%20Modelling%20Sector-Coupled%20Energy%20Systems.png)
 
-Data can be downloaded in the Zenodo link below and should be placed in RawDataProcessing/
+Data can be downloaded in the Zenodo link below and should be placed in src/
 
 https://zenodo.org/records/10960910
 

diff --git a/RawDataProcessing/docs/about.md → docs/about.md b/RawDataProcessing/docs/about.md → docs/about.md
diff --git a/RawDataProcessing/docs/chapter1.md → docs/chapter1.md b/RawDataProcessing/docs/chapter1.md → docs/chapter1.md
diff --git a/RawDataProcessing/docs/chapter1/section1.md → docs/chapter1/section1.md b/RawDataProcessing/docs/chapter1/section1.md → docs/chapter1/section1.md
diff --git a/RawDataProcessing/docs/chapter1/section2.md → docs/chapter1/section2.md b/RawDataProcessing/docs/chapter1/section2.md → docs/chapter1/section2.md
diff --git a/RawDataProcessing/docs/conf.py → docs/conf.py b/RawDataProcessing/docs/conf.py → docs/conf.py
@@ -5,7 +5,7 @@
 
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", ".venv", ".venv/**"]
 
-conf_py_path = "RawDataProcessing/docs/"  # with leading and trailing slash
+conf_py_path = "docs/"  # with leading and trailing slash
 
 html_static_path = ["css"]
 

diff --git a/RawDataProcessing/docs/css/css_options.css → docs/css/css_options.css b/RawDataProcessing/docs/css/css_options.css → docs/css/css_options.css
diff --git a/RawDataProcessing/docs/docs_environment.yml → docs/docs_environment.yml b/RawDataProcessing/docs/docs_environment.yml → docs/docs_environment.yml
diff --git a/...ataProcessing/docs/img/sankey-diagram.png → docs/img/sankey-diagram.png b/...ataProcessing/docs/img/sankey-diagram.png → docs/img/sankey-diagram.png
diff --git a/RawDataProcessing/docs/index.md → docs/index.md b/RawDataProcessing/docs/index.md → docs/index.md
diff --git a/RawDataProcessing/Analysis/dot_source.txt → src/Analysis/dot_source.txt b/RawDataProcessing/Analysis/dot_source.txt → src/Analysis/dot_source.txt
diff --git a/RawDataProcessing/Analysis/plot_dag.py → src/Analysis/plot_dag.py b/RawDataProcessing/Analysis/plot_dag.py → src/Analysis/plot_dag.py
diff --git a/RawDataProcessing/Analysis/snakemake_dag.pdf → src/Analysis/snakemake_dag.pdf b/RawDataProcessing/Analysis/snakemake_dag.pdf → src/Analysis/snakemake_dag.pdf
diff --git a/...delling Sector-Coupled Energy Systems.png → ...delling Sector-Coupled Energy Systems.png b/...delling Sector-Coupled Energy Systems.png → ...delling Sector-Coupled Energy Systems.png
diff --git a/...modules/create_conversion_dictionaries.py → ...modules/create_conversion_dictionaries.py b/...modules/create_conversion_dictionaries.py → ...modules/create_conversion_dictionaries.py
diff --git a/...Processing/Modules/Submodules/get_grid.py → src/Modules/Submodules/get_grid.py b/...Processing/Modules/Submodules/get_grid.py → src/Modules/Submodules/get_grid.py
diff --git a/.../Modules/Submodules/municipal_template.py → src/Modules/Submodules/municipal_template.py b/.../Modules/Submodules/municipal_template.py → src/Modules/Submodules/municipal_template.py
diff --git a/...les/Submodules/read_futuregas_profiles.py → ...les/Submodules/read_futuregas_profiles.py b/...les/Submodules/read_futuregas_profiles.py → ...les/Submodules/read_futuregas_profiles.py
diff --git a/...ataProcessing/Modules/Submodules/utils.py → src/Modules/Submodules/utils.py b/...ataProcessing/Modules/Submodules/utils.py → src/Modules/Submodules/utils.py
diff --git a/RawDataProcessing/Modules/clustering.py → src/Modules/clustering.py b/RawDataProcessing/Modules/clustering.py → src/Modules/clustering.py
@@ -92,7 +92,7 @@ def convert_municipal_code_to_name(to_be_converted: pd.DataFrame,
                                     column_to_convert: (str, int),
                                     pivot_table: bool = False,
                                     exclude_regions: list = ['Herlev', 'Christiansø'],
-                                    muni_geofile_path: str = r'C:\Users\mberos\gitRepos\balmorel-preprocessing\RawDataProcessing\Data\Shapefiles\Denmark\Adm\gadm36_DNK_2.shp'):
+                                    muni_geofile_path: str = r'C:\Users\mberos\gitRepos\balmorel-preprocessing\src\Data\Shapefiles\Denmark\Adm\gadm36_DNK_2.shp'):
 
     index, muni_geofile, country = prepared_geofiles('DK Municipalities')
 

diff --git a/RawDataProcessing/Modules/createDH.py → src/Modules/createDH.py b/RawDataProcessing/Modules/createDH.py → src/Modules/createDH.py
diff --git a/RawDataProcessing/Modules/createFLEXDEM.py → src/Modules/createFLEXDEM.py b/RawDataProcessing/Modules/createFLEXDEM.py → src/Modules/createFLEXDEM.py
diff --git a/RawDataProcessing/Modules/createHYDROGEN.py → src/Modules/createHYDROGEN.py b/RawDataProcessing/Modules/createHYDROGEN.py → src/Modules/createHYDROGEN.py
diff --git a/RawDataProcessing/Modules/createINDUSTRY.py → src/Modules/createINDUSTRY.py b/RawDataProcessing/Modules/createINDUSTRY.py → src/Modules/createINDUSTRY.py
diff --git a/RawDataProcessing/Modules/createVRE.py → src/Modules/createVRE.py b/RawDataProcessing/Modules/createVRE.py → src/Modules/createVRE.py
diff --git a/...cessing/Modules/exo_electricity_demand.py → src/Modules/exo_electricity_demand.py b/...cessing/Modules/exo_electricity_demand.py → src/Modules/exo_electricity_demand.py
diff --git a/RawDataProcessing/Modules/exo_heat_demand.py → src/Modules/exo_heat_demand.py b/RawDataProcessing/Modules/exo_heat_demand.py → src/Modules/exo_heat_demand.py
diff --git a/RawDataProcessing/Modules/format_dkstat.py → src/Modules/format_dkstat.py b/RawDataProcessing/Modules/format_dkstat.py → src/Modules/format_dkstat.py
diff --git a/...ataProcessing/Modules/format_energinet.py → src/Modules/format_energinet.py b/...ataProcessing/Modules/format_energinet.py → src/Modules/format_energinet.py
diff --git a/RawDataProcessing/Modules/format_vpdk21.py → src/Modules/format_vpdk21.py b/RawDataProcessing/Modules/format_vpdk21.py → src/Modules/format_vpdk21.py
diff --git a/RawDataProcessing/Modules/geofiles.py → src/Modules/geofiles.py b/RawDataProcessing/Modules/geofiles.py → src/Modules/geofiles.py
diff --git a/RawDataProcessing/README.md → src/README.md b/RawDataProcessing/README.md → src/README.md
diff --git a/RawDataProcessing/create_Demands.py → src/create_Demands.py b/RawDataProcessing/create_Demands.py → src/create_Demands.py
diff --git a/RawDataProcessing/create_GKFX_DK.py → src/create_GKFX_DK.py b/RawDataProcessing/create_GKFX_DK.py → src/create_GKFX_DK.py
diff --git a/RawDataProcessing/create_Grids.py → src/create_Grids.py b/RawDataProcessing/create_Grids.py → src/create_Grids.py
diff --git a/RawDataProcessing/create_SetFiles.py → src/create_SetFiles.py b/RawDataProcessing/create_SetFiles.py → src/create_SetFiles.py
diff --git a/RawDataProcessing/create_TechData.py → src/create_TechData.py b/RawDataProcessing/create_TechData.py → src/create_TechData.py
diff --git a/RawDataProcessing/main.py → src/main.py b/RawDataProcessing/main.py → src/main.py
diff --git a/RawDataProcessing/snakefile → src/snakefile b/RawDataProcessing/snakefile → src/snakefile