Merge pull request #60 from Open-ISP/dist-build

Dist build

Author: nick-gorman

README.md

@@ -28,7 +28,7 @@ uv add ispypsa
 
 ## Quick Start
 
-1. Download the [example config](docs/downloads/ispypsa_config.yaml) and edit paths for your environment
+1. Download the [example config](ispypsa_config.yaml) and edit paths for your environment
 2. Run:
 
 ```bash

docs/api.md

@@ -56,9 +56,9 @@ Python script.
 
 ::: ispypsa.pypsa_build.build_pypsa_network
 
-::: ispypsa.pypas_build.update_network_timeseries
+::: ispypsa.pypsa_build.update_network_timeseries
 
-::: ispypsa.pypas_build.save_pypsa_network
+::: ispypsa.pypsa_build.save_pypsa_network
 
 ## Tabular Results Extraction
 

docs/getting_started.md

@@ -69,22 +69,21 @@ pip install or a python package manager can install ISPyPSA
       # ===== Path configuration =============================================================
 
       paths:
+        # The run directory where all inputs and outputs will be stored
+        run_directory: "ispypsa_runs"
+
         # The name of the ISPyPSA model run
         # This name is used to select the output folder within `ispypsa_runs`
         ispypsa_run_name: example_model_run
 
-        # Base directory where trace data will be downloaded
-        # The download task will create isp_2024 subdirectory automatically
+        # The path to the folder containing parsed demand, wind and solar traces.
         parsed_traces_directory: "data/trace_data"
 
-        # Path where the ISP Excel workbook will be downloaded
+        # The path to the ISP workbook Excel file
         workbook_path: "data/2024-isp-inputs-and-assumptions-workbook.xlsx"
 
         # The path to the workbook table cache directory
         parsed_workbook_cache: "data/workbook_table_cache"
-
-        # The run directory where all inputs and outputs will be stored
-        run_directory: "ispypsa_runs"
      ```
 
 !!! Important "Relative paths"

ispypsa_config.yaml

@@ -1,23 +1,21 @@
 # ===== Paths ==========================================================================
 
 paths:
-  # The path to the folder containing parsed demand, wind and solar traces.
-  # If set to ENV the path will be retrieved from the environment variable
-  # "PATH_TO_PARSED_TRACES"
-  parsed_traces_directory: ENV
-
-  # The path to the ISP workbook Excel file
-  workbook_path: "../isp-workbook-parser/workbooks/6.0/2024-isp-inputs-and-assumptions-workbook.xlsx"
-
-  # The path to the workbook table cache directory
-  parsed_workbook_cache: "ispypsa_runs/workbook_table_cache"
-
   # The run directory where all inputs and outputs will be stored
   run_directory: "ispypsa_runs"
 
   # The name of the ISPyPSA model run
   # This name is used to select the output folder within `ispypsa_runs`
-  ispypsa_run_name: overnight_build_nsw_2050
+  ispypsa_run_name: example_model_run
+
+  # The path to the folder containing parsed demand, wind and solar traces.
+  parsed_traces_directory: "data/trace_data"
+
+  # The path to the ISP workbook Excel file
+  workbook_path: "data/2024-isp-inputs-and-assumptions-workbook.xlsx"
+
+  # The path to the workbook table cache directory
+  parsed_workbook_cache: "data/workbook_table_cache"
 
 
 # ===== Trace Data =====================================================================

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ISPyPSA"
-version = "0.1.0beta1"
+version = "0.1.1beta1"
 description = "An open-source capacity expansion model based on the methodology and datasets used by the Australian Energy Market Operator (AEMO) in their Integrated System Plan (ISP)."
 authors = [
     { name = "prakaa", email = "abiprakash007@gmail.com" },
@@ -26,7 +26,7 @@ dependencies = [
     "mkdocs-material>=9.6.18",
 ]
 readme = "README.md"
-requires-python = ">= 3.10"
+requires-python = ">=3.10,<3.13"
 
 [project.scripts]
 ispypsa = "ispypsa.cli.cli:main"

src/ispypsa/cli/dodo.py

@@ -47,12 +47,22 @@
 
 config_path = get_var("config", None)
 
+DOIT_CONFIG = {
+    "default_tasks": [
+        "cache_required_iasr_workbook_tables",
+        "create_ispypsa_inputs",
+        "create_pypsa_friendly_inputs",
+        "create_and_run_capacity_expansion_model",
+        "create_and_run_operational_model",
+    ]
+}
+
 if config_path:
     config = load_config(Path(config_path))
 
     run_dir = Path(config.paths.run_directory) / config.paths.ispypsa_run_name
     run_dir.mkdir(parents=True, exist_ok=True)
-    DOIT_CONFIG = {"dep_file": run_dir / "doit.db"}
+    DOIT_CONFIG.update({"dep_file": run_dir / "doit.db"})
 
 else:
     config = None