feat(language)!: a construct that reads the order of a dimension needs the dimension declared ordered

CHANGELOG.md

@@ -12,6 +12,7 @@ it releases that version ([RELEASING.md](https://github.com/energy-models/mathsp
 
 ## Upcoming version
 
+- feat(language)!: a construct that reads the order of a dimension needs the dimension declared ordered ([#793](https://github.com/energy-models/mathspec/pull/793))
 - docs(pypsa): the pypsa reference targets master at 51986084, where the eight rungs that diverged now match ([#844](https://github.com/energy-models/mathspec/pull/844))
 - feat(language)!: a call names the columns of a relation as relation[column], and a sum through a relation is a sum over the axes its join opens ([#664](https://github.com/energy-models/mathspec/pull/664))
 - docs(pypsa): the linearized unit commitment is a patch over pypsa.yaml, and relaxes a committable link and process too ([#835](https://github.com/energy-models/mathspec/pull/835))

docs/about/limits.md

@@ -8,7 +8,7 @@ SPDX-License-Identifier: CC-BY-4.0
 A spec can only say what the language has words for. This page says which words
 can be added, and which cannot. Read it before you ask for a new operator, block
 or keyword. For the rules a spec itself has to obey, read
-[the ten rules](../reference/language/index.md#the-ten-rules).
+[the eleven rules](../reference/language/index.md#the-eleven-rules).
 
 ## How a new construct enters
 

docs/examples/commitment.md

@@ -22,7 +22,7 @@ description: >-
   inequality is written once.
 
 dimensions:
-  snapshot: { dtype: int, description: dispatch periods }
+  snapshot: { dtype: int, description: dispatch periods, ordered: true }
   generator: { description: generating units }
 
 parameters:

docs/examples/operators.md

@@ -287,7 +287,7 @@ description: >-
   it would have fed is not built.
 
 dimensions:
-  snapshot: { dtype: int }
+  snapshot: { dtype: int, ordered: true }
 
 variables:
   p:
@@ -314,7 +314,7 @@ description: >-
   reads the last and nothing is vacated.
 
 dimensions:
-  snapshot: { dtype: int }
+  snapshot: { dtype: int, ordered: true }
 
 variables:
   p:
@@ -341,7 +341,7 @@ description: >-
   number instead of being absent, so the row survives.
 
 dimensions:
-  snapshot: { dtype: int }
+  snapshot: { dtype: int, ordered: true }
 
 variables:
   p:
@@ -370,7 +370,7 @@ description: >-
 
 dimensions:
   technology: { dtype: str }
-  month: { dtype: int }
+  month: { dtype: int, ordered: true }
 
 parameters:
   lead: { dims: [technology], dtype: int }
@@ -401,7 +401,7 @@ description: >-
   snapshot reads that season's last and no level crosses the boundary.
 
 dimensions:
-  snapshot: { dtype: int }
+  snapshot: { dtype: int, ordered: true }
   season: { dtype: str }
 
 relations:
@@ -433,7 +433,7 @@ description: >-
 
 dimensions:
   unit: { dtype: str }
-  hour: { dtype: int }
+  hour: { dtype: int, ordered: true }
 
 parameters:
   min_up: { dims: [unit], dtype: int }
@@ -467,7 +467,7 @@ description: >-
 
 dimensions:
   unit: { dtype: str }
-  hour: { dtype: int }
+  hour: { dtype: int, ordered: true }
 
 parameters:
   min_up: { dims: [unit], dtype: int }
@@ -501,7 +501,7 @@ description: >-
 
 dimensions:
   unit: { dtype: str }
-  hour: { dtype: int }
+  hour: { dtype: int, ordered: true }
 
 parameters:
   min_up: { dims: [unit], dtype: int }
@@ -536,7 +536,7 @@ description: >-
 
 dimensions:
   unit: { dtype: str }
-  hour: { dtype: int }
+  hour: { dtype: int, ordered: true }
   day: { dtype: str }
 
 relations:

docs/examples/pypsa/carrier.md

@@ -13,6 +13,7 @@ dimensions:
   period:
     description: investment periods — PyPSA's `investment_periods`
     dtype: int
+    ordered: true
   carrier:
     description: energy carriers, what a growth limit is set per
 

docs/examples/pypsa/generator.md

@@ -15,6 +15,7 @@ dimensions:
   snapshot:
     description: dispatch periods
     dtype: datetime
+    ordered: true
   bus:
     description: network nodes
   generator:
@@ -24,6 +25,7 @@ dimensions:
   period:
     description: investment periods — PyPSA's `investment_periods`
     dtype: int
+    ordered: true
   carrier:
     description: energy carriers, what a growth limit is set per
 

docs/examples/pypsa/generator_commitment.md

@@ -15,11 +15,13 @@ dimensions:
   snapshot:
     description: dispatch periods
     dtype: datetime
+    ordered: true
   generator:
     description: generating units, each on one bus
   period:
     description: investment periods — PyPSA's `investment_periods`
     dtype: int
+    ordered: true
 
 relations:
   snapshot_period:

docs/examples/pypsa/generator_maintenance.md

@@ -15,6 +15,7 @@ dimensions:
   snapshot:
     description: dispatch periods
     dtype: datetime
+    ordered: true
   generator:
     description: generating units, each on one bus
 

docs/examples/pypsa/generator_ramping.md

@@ -15,11 +15,13 @@ dimensions:
   snapshot:
     description: dispatch periods
     dtype: datetime
+    ordered: true
   generator:
     description: generating units, each on one bus
   period:
     description: investment periods — PyPSA's `investment_periods`
     dtype: int
+    ordered: true
 
 relations:
   snapshot_period:

docs/examples/pypsa/line.md

@@ -15,6 +15,7 @@ dimensions:
   snapshot:
     description: dispatch periods
     dtype: datetime
+    ordered: true
   bus:
     description: network nodes
   line:
@@ -36,6 +37,7 @@ dimensions:
   period:
     description: investment periods — PyPSA's `investment_periods`
     dtype: int
+    ordered: true
   carrier:
     description: energy carriers, what a growth limit is set per
 

docs/examples/pypsa/link.md

@@ -15,6 +15,7 @@ dimensions:
   snapshot:
     description: dispatch periods
     dtype: datetime
+    ordered: true
   bus:
     description: network nodes
   link:
@@ -29,6 +30,7 @@ dimensions:
   period:
     description: investment periods — PyPSA's `investment_periods`
     dtype: int
+    ordered: true
   carrier:
     description: energy carriers, what a growth limit is set per
 

docs/examples/pypsa/link_commitment.md

@@ -15,11 +15,13 @@ dimensions:
   snapshot:
     description: dispatch periods
     dtype: datetime
+    ordered: true
   link:
     description: controllable connections, each from one bus to the buses it delivers to
   period:
     description: investment periods — PyPSA's `investment_periods`
     dtype: int
+    ordered: true
 
 relations:
   snapshot_period:

docs/examples/pypsa/link_maintenance.md

@@ -15,6 +15,7 @@ dimensions:
   snapshot:
     description: dispatch periods
     dtype: datetime
+    ordered: true
   link:
     description: controllable connections, each from one bus to the buses it delivers to
 

docs/examples/pypsa/link_ramping.md

@@ -15,11 +15,13 @@ dimensions:
   snapshot:
     description: dispatch periods
     dtype: datetime
+    ordered: true
   link:
     description: controllable connections, each from one bus to the buses it delivers to
   period:
     description: investment periods — PyPSA's `investment_periods`
     dtype: int
+    ordered: true
 
 relations:
   snapshot_period:

docs/examples/pypsa/load.md

@@ -15,6 +15,7 @@ dimensions:
   snapshot:
     description: dispatch periods
     dtype: datetime
+    ordered: true
   bus:
     description: network nodes
   load:

docs/examples/pypsa/network.md

@@ -15,6 +15,7 @@ dimensions:
   snapshot:
     description: dispatch periods
     dtype: datetime
+    ordered: true
   bus:
     description: network nodes
 

docs/examples/pypsa/power_flow.md

@@ -15,6 +15,7 @@ dimensions:
   snapshot:
     description: dispatch periods
     dtype: datetime
+    ordered: true
   cycle:
     description: >-
       independent cycles of the passive network graph — the cycle basis, data

docs/examples/pypsa/process.md

@@ -15,6 +15,7 @@ dimensions:
   snapshot:
     description: dispatch periods
     dtype: datetime
+    ordered: true
   bus:
     description: network nodes
   process:
@@ -29,6 +30,7 @@ dimensions:
   period:
     description: investment periods — PyPSA's `investment_periods`
     dtype: int
+    ordered: true
   carrier:
     description: energy carriers, what a growth limit is set per
 

docs/examples/pypsa/process_commitment.md

@@ -15,11 +15,13 @@ dimensions:
   snapshot:
     description: dispatch periods
     dtype: datetime
+    ordered: true
   process:
     description: generalized multi-port converters, each with an internal power that every port draws or delivers at its own rate
   period:
     description: investment periods — PyPSA's `investment_periods`
     dtype: int
+    ordered: true
 
 relations:
   snapshot_period:

docs/examples/pypsa/process_maintenance.md

@@ -15,6 +15,7 @@ dimensions:
   snapshot:
     description: dispatch periods
     dtype: datetime
+    ordered: true
   process:
     description: generalized multi-port converters, each with an internal power that every port draws or delivers at its own rate
 

docs/examples/pypsa/process_ramping.md

@@ -15,11 +15,13 @@ dimensions:
   snapshot:
     description: dispatch periods
     dtype: datetime
+    ordered: true
   process:
     description: generalized multi-port converters, each with an internal power that every port draws or delivers at its own rate
   period:
     description: investment periods — PyPSA's `investment_periods`
     dtype: int
+    ordered: true
 
 relations:
   snapshot_period:

docs/examples/pypsa/security.md

@@ -15,6 +15,7 @@ dimensions:
   snapshot:
     description: dispatch periods
     dtype: datetime
+    ordered: true
   line:
     description: passive branches, each between two buses, their flow set by impedance
   transformer:
@@ -27,6 +28,7 @@ dimensions:
   period:
     description: investment periods — PyPSA's `investment_periods`
     dtype: int
+    ordered: true
 
 relations:
   snapshot_period:

docs/examples/pypsa/settings.md

@@ -15,11 +15,13 @@ dimensions:
   snapshot:
     description: dispatch periods
     dtype: datetime
+    ordered: true
   global_constraint:
     description: PyPSA's `GlobalConstraint` rows, one label per declared limit
   period:
     description: investment periods — PyPSA's `investment_periods`
     dtype: int
+    ordered: true
   carrier:
     description: energy carriers, what a growth limit is set per
 

docs/examples/pypsa/storage_unit.md

@@ -15,6 +15,7 @@ dimensions:
   snapshot:
     description: dispatch periods
     dtype: datetime
+    ordered: true
   bus:
     description: network nodes
   storage_unit:
@@ -24,6 +25,7 @@ dimensions:
   period:
     description: investment periods — PyPSA's `investment_periods`
     dtype: int
+    ordered: true
   carrier:
     description: energy carriers, what a growth limit is set per
 

docs/examples/pypsa/store.md

@@ -15,6 +15,7 @@ dimensions:
   snapshot:
     description: dispatch periods
     dtype: datetime
+    ordered: true
   bus:
     description: network nodes
   store:
@@ -24,6 +25,7 @@ dimensions:
   period:
     description: investment periods — PyPSA's `investment_periods`
     dtype: int
+    ordered: true
   carrier:
     description: energy carriers, what a growth limit is set per
 

docs/examples/pypsa/transformer.md

@@ -15,6 +15,7 @@ dimensions:
   snapshot:
     description: dispatch periods
     dtype: datetime
+    ordered: true
   bus:
     description: network nodes
   transformer:
@@ -34,6 +35,7 @@ dimensions:
   period:
     description: investment periods — PyPSA's `investment_periods`
     dtype: int
+    ordered: true
 
 relations:
   snapshot_period: