Year to milestone year (#51)

gnawin · abelsiqueira · web-flow · commit 0de315803b38 · 2026-02-27T18:50:06.000+01:00
* year to milestone year

* Fix tests

* Relax TC dependency

* Temporary fix Norse test

* change downstream test version

* Fix json lint

* Add TC custom layout

* Fix lint

* Remove hack

* Fix docs

* Release v0.2.0

---------

Co-authored-by: Abel Soares Siqueira &lt;abel.siqueira@esciencecenter.nl&gt;
diff --git a/.github/downstream.json b/.github/downstream.json
@@ -2,6 +2,6 @@
   {
     "package": "TulipaEnergyModel",
     "user": "TulipaEnergy",
-    "version": "latest"
+    "version": "1086-verbose-year"
   }
 ]
diff --git a/Project.toml b/Project.toml
@@ -1,6 +1,6 @@
 name = "TulipaBuilder"
 uuid = "05fe4dc7-9a58-53a4-b912-b5673d74e816"
-version = "0.1.5"
+version = "0.2.0"
 authors = ["Abel Soares Siqueira"]
 
 [workspace]
@@ -19,6 +19,6 @@ DataFrames = "1.7.0"
 DuckDB = "1.3.1"
 Graphs = "1.13.0"
 MetaGraphsNext = "0.7.3, 0.8"
-TulipaEnergyModel = "0.17, 0.18, 0.19, 0.20"
+TulipaEnergyModel = "0.21"
 TulipaIO = "0.5.0"
 julia = "1.10"
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -32,4 +32,3 @@ NetworkLayout = "0.4"
 Plots = "1"
 Statistics = "1"
 TulipaClustering = "0.5"
-TulipaEnergyModel = "0.19, 0.20"
diff --git a/docs/src/10-tutorials/10-basic.md b/docs/src/10-tutorials/10-basic.md
@@ -63,7 +63,7 @@ For completeness, here is rest of the pipeline for clustering, populating with d
 # Don't forget to cluster and populate with defaults before solving the problem
 using TulipaEnergyModel, TulipaClustering
 
-dummy_cluster!(connection)
+dummy_cluster!(connection; layout = TC.ProfilesTableLayout(year = :milestone_year))
 populate_with_defaults!(connection)
 ep = run_scenario(connection)
 ```
diff --git a/src/create-connection.jl b/src/create-connection.jl
@@ -441,7 +441,7 @@ function create_connection(tulipa::TulipaData, db = ":memory:")
         connection,
         "CREATE OR REPLACE TABLE profiles (
             profile_name VARCHAR,
-            year INT64,
+            milestone_year INT64,
             scenario INT64,
             timestep INT64,
             value DOUBLE,
@@ -469,7 +469,7 @@ function create_connection(tulipa::TulipaData, db = ":memory:")
             # Use DataFrame for efficient bulk insertion
             profiles_df = DataFrame(
                 profile_name = profile_name,
-                year = year,
+                milestone_year = year,
                 scenario = scenario,
                 timestep = 1:length(profile_value),
                 value = profile_value,
@@ -511,7 +511,7 @@ function create_connection(tulipa::TulipaData, db = ":memory:")
             "CREATE OR REPLACE TABLE flows_profiles (
                 from_asset VARCHAR,
                 to_asset VARCHAR,
-                year INT64,
+                milestone_year INT64,
                 profile_name VARCHAR,
                 profile_type VARCHAR,
             )",
@@ -523,7 +523,7 @@ function create_connection(tulipa::TulipaData, db = ":memory:")
                 profile_name = "$from_asset_name-$to_asset_name-$profile_type-$year"
                 profiles_df = DataFrame(
                     profile_name = profile_name,
-                    year = year,
+                    milestone_year = year,
                     scenario = scenario,
                     timestep = 1:length(profile_value),
                     value = profile_value,
@@ -543,7 +543,7 @@ function create_connection(tulipa::TulipaData, db = ":memory:")
                         "INSERT INTO flows_profiles BY NAME (SELECT
                             '$from_asset_name' AS from_asset,
                             '$to_asset_name' AS to_asset,
-                            $year AS year,
+                            $year AS milestone_year,
                             '$profile_name' AS profile_name,
                             '$profile_type' AS profile_type,
                         )",
@@ -660,7 +660,7 @@ function create_connection(tulipa::TulipaData, db = ":memory:")
     end
 
     # Table assets_rep_periods_partitions
-    columns = ["asset", "year", "rep_period", "specification", "partition"]
+    columns = ["asset", "milestone_year", "rep_period", "specification", "partition"]
     need_table = any(
         length(tulipa.graph[a].partitions) > 0 for a in MetaGraphsNext.labels(tulipa.graph)
     )
@@ -679,7 +679,7 @@ function create_connection(tulipa::TulipaData, db = ":memory:")
             end
             for ((year, rep_period), value) in partitions
                 query = "INSERT INTO assets_rep_periods_partitions BY NAME (SELECT '$asset_name' AS asset, "
-                query *= "$year as year, $rep_period as rep_period,"
+                query *= "$year as milestone_year, $rep_period as rep_period,"
                 specification = get(value, :specification, "uniform")
                 partition = value[:partition] # no default for partition
                 query *= _get_select_query_row(
@@ -698,7 +698,14 @@ function create_connection(tulipa::TulipaData, db = ":memory:")
         end
     end
 
-    columns = ["from_asset", "to_asset", "year", "rep_period", "specification", "partition"]
+    columns = [
+        "from_asset",
+        "to_asset",
+        "milestone_year",
+        "rep_period",
+        "specification",
+        "partition",
+    ]
     need_table = any(
         length(tulipa.graph[e...].partitions) > 0 for
         e in MetaGraphsNext.edge_labels(tulipa.graph)
@@ -718,7 +725,7 @@ function create_connection(tulipa::TulipaData, db = ":memory:")
             end
             for ((year, rep_period), value) in partitions
                 query = "INSERT INTO flows_rep_periods_partitions BY NAME (SELECT '$from_asset_name' AS from_asset, '$to_asset_name' AS to_asset,"
-                query *= "$year as year, $rep_period as rep_period, "
+                query *= "$year as milestone_year, $rep_period as rep_period, "
                 specification = get(value, :specification, "uniform")
                 partition = value[:partition] # no default for partition
                 query *= _get_select_query_row(
diff --git a/test/Project.toml b/test/Project.toml
@@ -23,5 +23,4 @@ JuMP = "1"
 TOML = "1"
 TestItemRunner = "1"
 TulipaClustering = "0.5"
-TulipaEnergyModel = "0.19, 0.20"
 XLSX = "0.10"
diff --git a/test/test-basic.jl b/test/test-basic.jl
@@ -50,7 +50,7 @@
     connection = create_connection(tulipa)
 
     # External
-    TC.dummy_cluster!(connection)
+    TC.dummy_cluster!(connection; layout = TC.ProfilesTableLayout(year = :milestone_year))
     TEM.populate_with_defaults!(connection)
     ep = TEM.run_scenario(connection, show_log = false, model_file_name = "model.lp")
     @test JuMP.is_solved_and_feasible(ep.model)
diff --git a/test/test-integration-norse.jl b/test/test-integration-norse.jl
@@ -501,13 +501,18 @@ end
     # External
     period_duration = 24
     num_rep_periods = 1
-    TC.cluster!(connection, period_duration, num_rep_periods)
+    TC.cluster!(
+        connection,
+        period_duration,
+        num_rep_periods;
+        layout = TC.ProfilesTableLayout(year = :milestone_year),
+    )
     # Manually changing the data because we can't currently cluster as Norse
     # See https://github.com/TulipaEnergy/TulipaClustering.jl/discussions/144
     DuckDB.query(connection, "UPDATE rep_periods_data SET num_timesteps = 168")
     DuckDB.query(
         connection,
-        "INSERT INTO rep_periods_data (rep_period, year, num_timesteps, resolution) VALUES (2, 2030, 24, 1.0)",
+        "INSERT INTO rep_periods_data (rep_period, milestone_year, num_timesteps, resolution) VALUES (2, 2030, 24, 1.0)",
     )
     TEM.populate_with_defaults!(connection)
 
diff --git a/test/test-integration-tiny.jl b/test/test-integration-tiny.jl
@@ -108,7 +108,12 @@ end
     # External
     period_duration = 24
     num_rep_periods = 3
-    TC.cluster!(connection, period_duration, num_rep_periods)
+    TC.cluster!(
+        connection,
+        period_duration,
+        num_rep_periods;
+        layout = TC.ProfilesTableLayout(year = :milestone_year),
+    )
     TEM.populate_with_defaults!(connection)
 
     # Comparison
diff --git a/test/test-output.jl b/test/test-output.jl
@@ -12,7 +12,10 @@
     function create_and_get_data(tulipa; cluster = false, populate_with_defaults = false)
         connection = create_connection(tulipa)
         if cluster
-            TC.dummy_cluster!(connection)
+            TC.dummy_cluster!(
+                connection;
+                layout = TC.ProfilesTableLayout(year = :milestone_year),
+            )
         end
         if populate_with_defaults
             TEM.populate_with_defaults!(connection)
@@ -60,7 +63,7 @@
             ),
             :profiles => DataFrame(
                 profile_name = String[],
-                year = Int[],
+                milestone_year = Int[],
                 scenario = Int[],
                 timestep = Int[],
                 value = Float64[],

Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,6 @@`
`2`	`2`	`{`
`3`	`3`	`"package": "TulipaEnergyModel",`
`4`	`4`	`"user": "TulipaEnergy",`
`5`		`- "version": "latest"`
	`5`	`+ "version": "1086-verbose-year"`
`6`	`6`	`}`
`7`	`7`	`]`