Skip to content

Commit 6b7f831

Browse files
JrtPecJrtPec
committed
more annotations
1 parent 6f8187d commit 6b7f831

File tree

5 files changed

+120
-93
lines changed

5 files changed

+120
-93
lines changed

‎demo_energiedelen.ipynb‎

Lines changed: 79 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
"outputs": [],
2828
"source": [
2929
"from openenergyid import TimeDataFrame\n",
30-
"from openenergyid.energysharing import EnergySharingInput, EnergySharingOutput, calculate, CalculationMethod"
30+
"from openenergyid.energysharing import EnergySharingInput, EnergySharingOutput, calculate, CalculationMethod, KeyInput"
3131
]
3232
},
3333
{
@@ -388,10 +388,10 @@
388388
"input = EnergySharingInput.model_construct(\n",
389389
" gross_injection=TimeDataFrame.from_pandas(gross_injection),\n",
390390
" gross_offtake=TimeDataFrame.from_pandas(gross_offtake),\n",
391-
" key=TimeDataFrame.from_pandas(key),\n",
391+
" key=KeyInput.from_pandas(key)\n",
392392
")\n",
393393
"\n",
394-
"df = input.data_frame()"
394+
"df = input.to_pandas()"
395395
]
396396
},
397397
{
@@ -448,7 +448,7 @@
448448
" </thead>\n",
449449
" <tbody>\n",
450450
" <tr>\n",
451-
" <th>2024-01-01 12:00:00+01:00</th>\n",
451+
" <th>2024-01-01 11:00:00+00:00</th>\n",
452452
" <td>70</td>\n",
453453
" <td>10</td>\n",
454454
" <td>20</td>\n",
@@ -469,7 +469,7 @@
469469
" <td>0.225</td>\n",
470470
" </tr>\n",
471471
" <tr>\n",
472-
" <th>2024-01-01 12:15:00+01:00</th>\n",
472+
" <th>2024-01-01 11:15:00+00:00</th>\n",
473473
" <td>20</td>\n",
474474
" <td>10</td>\n",
475475
" <td>30</td>\n",
@@ -490,7 +490,7 @@
490490
" <td>0.225</td>\n",
491491
" </tr>\n",
492492
" <tr>\n",
493-
" <th>2024-01-01 12:30:00+01:00</th>\n",
493+
" <th>2024-01-01 11:30:00+00:00</th>\n",
494494
" <td>100</td>\n",
495495
" <td>10</td>\n",
496496
" <td>40</td>\n",
@@ -511,7 +511,7 @@
511511
" <td>0.225</td>\n",
512512
" </tr>\n",
513513
" <tr>\n",
514-
" <th>2024-01-01 12:45:00+01:00</th>\n",
514+
" <th>2024-01-01 11:45:00+00:00</th>\n",
515515
" <td>0</td>\n",
516516
" <td>10</td>\n",
517517
" <td>50</td>\n",
@@ -538,24 +538,24 @@
538538
"text/plain": [
539539
" Gross Injection Gross Offtake \\\n",
540540
" P1 P2 P3 P4 P5 P6 P1 P2 \n",
541-
"2024-01-01 12:00:00+01:00 70 10 20 0 0 0 0 30 \n",
542-
"2024-01-01 12:15:00+01:00 20 10 30 0 0 0 0 20 \n",
543-
"2024-01-01 12:30:00+01:00 100 10 40 0 0 0 0 10 \n",
544-
"2024-01-01 12:45:00+01:00 0 10 50 0 0 0 0 0 \n",
541+
"2024-01-01 11:00:00+00:00 70 10 20 0 0 0 0 30 \n",
542+
"2024-01-01 11:15:00+00:00 20 10 30 0 0 0 0 20 \n",
543+
"2024-01-01 11:30:00+00:00 100 10 40 0 0 0 0 10 \n",
544+
"2024-01-01 11:45:00+00:00 0 10 50 0 0 0 0 0 \n",
545545
"\n",
546546
" Key \\\n",
547547
" P3 P4 P5 P6 P1 P2 P3 P4 P5 \n",
548-
"2024-01-01 12:00:00+01:00 22 30 18 20 0.0 0.1 0.225 0.225 0.225 \n",
549-
"2024-01-01 12:15:00+01:00 20 25 17 22 0.0 0.1 0.225 0.225 0.225 \n",
550-
"2024-01-01 12:30:00+01:00 30 35 19 24 0.0 0.1 0.225 0.225 0.225 \n",
551-
"2024-01-01 12:45:00+01:00 40 10 25 26 0.0 0.1 0.225 0.225 0.225 \n",
548+
"2024-01-01 11:00:00+00:00 22 30 18 20 0.0 0.1 0.225 0.225 0.225 \n",
549+
"2024-01-01 11:15:00+00:00 20 25 17 22 0.0 0.1 0.225 0.225 0.225 \n",
550+
"2024-01-01 11:30:00+00:00 30 35 19 24 0.0 0.1 0.225 0.225 0.225 \n",
551+
"2024-01-01 11:45:00+00:00 40 10 25 26 0.0 0.1 0.225 0.225 0.225 \n",
552552
"\n",
553553
" \n",
554554
" P6 \n",
555-
"2024-01-01 12:00:00+01:00 0.225 \n",
556-
"2024-01-01 12:15:00+01:00 0.225 \n",
557-
"2024-01-01 12:30:00+01:00 0.225 \n",
558-
"2024-01-01 12:45:00+01:00 0.225 "
555+
"2024-01-01 11:00:00+00:00 0.225 \n",
556+
"2024-01-01 11:15:00+00:00 0.225 \n",
557+
"2024-01-01 11:30:00+00:00 0.225 \n",
558+
"2024-01-01 11:45:00+00:00 0.225 "
559559
]
560560
},
561561
"execution_count": 9,
@@ -630,7 +630,7 @@
630630
" </thead>\n",
631631
" <tbody>\n",
632632
" <tr>\n",
633-
" <th>2024-01-01 12:00:00+01:00</th>\n",
633+
" <th>2024-01-01 11:00:00+00:00</th>\n",
634634
" <td>4.9</td>\n",
635635
" <td>1.70</td>\n",
636636
" <td>5.90</td>\n",
@@ -651,7 +651,7 @@
651651
" <td>20.0</td>\n",
652652
" </tr>\n",
653653
" <tr>\n",
654-
" <th>2024-01-01 12:15:00+01:00</th>\n",
654+
" <th>2024-01-01 11:15:00+00:00</th>\n",
655655
" <td>0.0</td>\n",
656656
" <td>1.00</td>\n",
657657
" <td>6.75</td>\n",
@@ -672,7 +672,7 @@
672672
" <td>13.5</td>\n",
673673
" </tr>\n",
674674
" <tr>\n",
675-
" <th>2024-01-01 12:30:00+01:00</th>\n",
675+
" <th>2024-01-01 11:30:00+00:00</th>\n",
676676
" <td>19.0</td>\n",
677677
" <td>2.90</td>\n",
678678
" <td>16.60</td>\n",
@@ -693,7 +693,7 @@
693693
" <td>24.0</td>\n",
694694
" </tr>\n",
695695
" <tr>\n",
696-
" <th>2024-01-01 12:45:00+01:00</th>\n",
696+
" <th>2024-01-01 11:45:00+00:00</th>\n",
697697
" <td>0.0</td>\n",
698698
" <td>2.42</td>\n",
699699
" <td>18.33</td>\n",
@@ -720,24 +720,24 @@
720720
"text/plain": [
721721
" Net Injection \\\n",
722722
" P1 P2 P3 P4 P5 P6 \n",
723-
"2024-01-01 12:00:00+01:00 4.9 1.70 5.90 0.0 0.0 0.0 \n",
724-
"2024-01-01 12:15:00+01:00 0.0 1.00 6.75 0.0 0.0 0.0 \n",
725-
"2024-01-01 12:30:00+01:00 19.0 2.90 16.60 0.0 0.0 0.0 \n",
726-
"2024-01-01 12:45:00+01:00 0.0 2.42 18.33 0.0 0.0 0.0 \n",
723+
"2024-01-01 11:00:00+00:00 4.9 1.70 5.90 0.0 0.0 0.0 \n",
724+
"2024-01-01 11:15:00+00:00 0.0 1.00 6.75 0.0 0.0 0.0 \n",
725+
"2024-01-01 11:30:00+00:00 19.0 2.90 16.60 0.0 0.0 0.0 \n",
726+
"2024-01-01 11:45:00+00:00 0.0 2.42 18.33 0.0 0.0 0.0 \n",
727727
"\n",
728728
" Net Offtake \\\n",
729729
" P1 P2 P3 P4 P5 P6 \n",
730-
"2024-01-01 12:00:00+01:00 0.0 21.0 4.00 7.50 0.0 0.0 \n",
731-
"2024-01-01 12:15:00+01:00 0.0 15.0 13.25 11.50 3.5 8.5 \n",
732-
"2024-01-01 12:30:00+01:00 0.0 0.0 5.25 1.25 0.0 0.0 \n",
733-
"2024-01-01 12:45:00+01:00 0.0 0.0 37.75 0.00 11.5 12.5 \n",
730+
"2024-01-01 11:00:00+00:00 0.0 21.0 4.00 7.50 0.0 0.0 \n",
731+
"2024-01-01 11:15:00+00:00 0.0 15.0 13.25 11.50 3.5 8.5 \n",
732+
"2024-01-01 11:30:00+00:00 0.0 0.0 5.25 1.25 0.0 0.0 \n",
733+
"2024-01-01 11:45:00+00:00 0.0 0.0 37.75 0.00 11.5 12.5 \n",
734734
"\n",
735735
" Shared Energy \n",
736736
" P1 P2 P3 P4 P5 P6 \n",
737-
"2024-01-01 12:00:00+01:00 0.0 9.0 18.00 22.50 18.0 20.0 \n",
738-
"2024-01-01 12:15:00+01:00 0.0 5.0 6.75 13.50 13.5 13.5 \n",
739-
"2024-01-01 12:30:00+01:00 0.0 10.0 24.75 33.75 19.0 24.0 \n",
740-
"2024-01-01 12:45:00+01:00 0.0 0.0 2.25 10.00 13.5 13.5 "
737+
"2024-01-01 11:00:00+00:00 0.0 9.0 18.00 22.50 18.0 20.0 \n",
738+
"2024-01-01 11:15:00+00:00 0.0 5.0 6.75 13.50 13.5 13.5 \n",
739+
"2024-01-01 11:30:00+00:00 0.0 10.0 24.75 33.75 19.0 24.0 \n",
740+
"2024-01-01 11:45:00+00:00 0.0 0.0 2.25 10.00 13.5 13.5 "
741741
]
742742
},
743743
"execution_count": 10,
@@ -812,7 +812,7 @@
812812
" </thead>\n",
813813
" <tbody>\n",
814814
" <tr>\n",
815-
" <th>2024-01-01 12:00:00+01:00</th>\n",
815+
" <th>2024-01-01 11:00:00+00:00</th>\n",
816816
" <td>7.08</td>\n",
817817
" <td>1.01</td>\n",
818818
" <td>2.02</td>\n",
@@ -833,7 +833,7 @@
833833
" <td>20.00</td>\n",
834834
" </tr>\n",
835835
" <tr>\n",
836-
" <th>2024-01-01 12:15:00+01:00</th>\n",
836+
" <th>2024-01-01 11:15:00+00:00</th>\n",
837837
" <td>0.00</td>\n",
838838
" <td>0.00</td>\n",
839839
" <td>-0.00</td>\n",
@@ -854,7 +854,7 @@
854854
" <td>15.71</td>\n",
855855
" </tr>\n",
856856
" <tr>\n",
857-
" <th>2024-01-01 12:30:00+01:00</th>\n",
857+
" <th>2024-01-01 11:30:00+00:00</th>\n",
858858
" <td>24.67</td>\n",
859859
" <td>2.47</td>\n",
860860
" <td>9.87</td>\n",
@@ -875,7 +875,7 @@
875875
" <td>24.00</td>\n",
876876
" </tr>\n",
877877
" <tr>\n",
878-
" <th>2024-01-01 12:45:00+01:00</th>\n",
878+
" <th>2024-01-01 11:45:00+00:00</th>\n",
879879
" <td>0.00</td>\n",
880880
" <td>2.24</td>\n",
881881
" <td>11.22</td>\n",
@@ -902,24 +902,24 @@
902902
"text/plain": [
903903
" Net Injection \\\n",
904904
" P1 P2 P3 P4 P5 P6 \n",
905-
"2024-01-01 12:00:00+01:00 7.08 1.01 2.02 0.0 0.0 0.0 \n",
906-
"2024-01-01 12:15:00+01:00 0.00 0.00 -0.00 0.0 0.0 0.0 \n",
907-
"2024-01-01 12:30:00+01:00 24.67 2.47 9.87 0.0 0.0 0.0 \n",
908-
"2024-01-01 12:45:00+01:00 0.00 2.24 11.22 0.0 0.0 0.0 \n",
905+
"2024-01-01 11:00:00+00:00 7.08 1.01 2.02 0.0 0.0 0.0 \n",
906+
"2024-01-01 11:15:00+00:00 0.00 0.00 -0.00 0.0 0.0 0.0 \n",
907+
"2024-01-01 11:30:00+00:00 24.67 2.47 9.87 0.0 0.0 0.0 \n",
908+
"2024-01-01 11:45:00+00:00 0.00 2.24 11.22 0.0 0.0 0.0 \n",
909909
"\n",
910910
" Net Offtake \\\n",
911911
" P1 P2 P3 P4 P5 P6 \n",
912-
"2024-01-01 12:00:00+01:00 0.0 20.42 3.75 5.94 0.00 0.00 \n",
913-
"2024-01-01 12:15:00+01:00 0.0 14.13 13.00 9.29 1.29 6.29 \n",
914-
"2024-01-01 12:30:00+01:00 0.0 0.00 5.00 0.00 0.00 0.00 \n",
915-
"2024-01-01 12:45:00+01:00 0.0 0.00 37.50 0.00 7.98 8.98 \n",
912+
"2024-01-01 11:00:00+00:00 0.0 20.42 3.75 5.94 0.00 0.00 \n",
913+
"2024-01-01 11:15:00+00:00 0.0 14.13 13.00 9.29 1.29 6.29 \n",
914+
"2024-01-01 11:30:00+00:00 0.0 0.00 5.00 0.00 0.00 0.00 \n",
915+
"2024-01-01 11:45:00+00:00 0.0 0.00 37.50 0.00 7.98 8.98 \n",
916916
"\n",
917917
" Shared Energy \n",
918918
" P1 P2 P3 P4 P5 P6 \n",
919-
"2024-01-01 12:00:00+01:00 0.0 9.58 18.25 24.06 18.00 20.00 \n",
920-
"2024-01-01 12:15:00+01:00 0.0 5.87 7.00 15.71 15.71 15.71 \n",
921-
"2024-01-01 12:30:00+01:00 0.0 10.00 25.00 35.00 19.00 24.00 \n",
922-
"2024-01-01 12:45:00+01:00 0.0 0.00 2.50 10.00 17.02 17.02 "
919+
"2024-01-01 11:00:00+00:00 0.0 9.58 18.25 24.06 18.00 20.00 \n",
920+
"2024-01-01 11:15:00+00:00 0.0 5.87 7.00 15.71 15.71 15.71 \n",
921+
"2024-01-01 11:30:00+00:00 0.0 10.00 25.00 35.00 19.00 24.00 \n",
922+
"2024-01-01 11:45:00+00:00 0.0 0.00 2.50 10.00 17.02 17.02 "
923923
]
924924
},
925925
"execution_count": 11,
@@ -1000,7 +1000,7 @@
10001000
" </thead>\n",
10011001
" <tbody>\n",
10021002
" <tr>\n",
1003-
" <th>2024-01-01 12:00:00+01:00</th>\n",
1003+
" <th>2024-01-01 11:00:00+00:00</th>\n",
10041004
" <td>0.00</td>\n",
10051005
" <td>0.00</td>\n",
10061006
" <td>0.00</td>\n",
@@ -1021,7 +1021,7 @@
10211021
" <td>20.00</td>\n",
10221022
" </tr>\n",
10231023
" <tr>\n",
1024-
" <th>2024-01-01 12:15:00+01:00</th>\n",
1024+
" <th>2024-01-01 11:15:00+00:00</th>\n",
10251025
" <td>0.00</td>\n",
10261026
" <td>0.00</td>\n",
10271027
" <td>0.00</td>\n",
@@ -1042,7 +1042,7 @@
10421042
" <td>15.71</td>\n",
10431043
" </tr>\n",
10441044
" <tr>\n",
1045-
" <th>2024-01-01 12:30:00+01:00</th>\n",
1045+
" <th>2024-01-01 11:30:00+00:00</th>\n",
10461046
" <td>14.76</td>\n",
10471047
" <td>1.48</td>\n",
10481048
" <td>15.77</td>\n",
@@ -1063,7 +1063,7 @@
10631063
" <td>24.00</td>\n",
10641064
" </tr>\n",
10651065
" <tr>\n",
1066-
" <th>2024-01-01 12:45:00+01:00</th>\n",
1066+
" <th>2024-01-01 11:45:00+00:00</th>\n",
10671067
" <td>0.00</td>\n",
10681068
" <td>0.00</td>\n",
10691069
" <td>0.00</td>\n",
@@ -1090,24 +1090,24 @@
10901090
"text/plain": [
10911091
" Net Injection \\\n",
10921092
" P1 P2 P3 P4 P5 P6 \n",
1093-
"2024-01-01 12:00:00+01:00 0.00 0.00 0.00 0.0 0.0 0.0 \n",
1094-
"2024-01-01 12:15:00+01:00 0.00 0.00 0.00 0.0 0.0 0.0 \n",
1095-
"2024-01-01 12:30:00+01:00 14.76 1.48 15.77 0.0 0.0 0.0 \n",
1096-
"2024-01-01 12:45:00+01:00 0.00 0.00 0.00 0.0 0.0 0.0 \n",
1093+
"2024-01-01 11:00:00+00:00 0.00 0.00 0.00 0.0 0.0 0.0 \n",
1094+
"2024-01-01 11:15:00+00:00 0.00 0.00 0.00 0.0 0.0 0.0 \n",
1095+
"2024-01-01 11:30:00+00:00 14.76 1.48 15.77 0.0 0.0 0.0 \n",
1096+
"2024-01-01 11:45:00+00:00 0.00 0.00 0.00 0.0 0.0 0.0 \n",
10971097
"\n",
10981098
" Net Offtake \\\n",
10991099
" P1 P2 P3 P4 P5 P6 \n",
1100-
"2024-01-01 12:00:00+01:00 0.0 18.51 0.35 1.14 0.00 0.00 \n",
1101-
"2024-01-01 12:15:00+01:00 0.0 14.13 13.00 9.29 1.29 6.29 \n",
1102-
"2024-01-01 12:30:00+01:00 0.0 0.00 0.00 0.00 0.00 0.00 \n",
1103-
"2024-01-01 12:45:00+01:00 0.0 0.00 36.75 0.00 1.62 2.62 \n",
1100+
"2024-01-01 11:00:00+00:00 0.0 18.51 0.35 1.14 0.00 0.00 \n",
1101+
"2024-01-01 11:15:00+00:00 0.0 14.13 13.00 9.29 1.29 6.29 \n",
1102+
"2024-01-01 11:30:00+00:00 0.0 0.00 0.00 0.00 0.00 0.00 \n",
1103+
"2024-01-01 11:45:00+00:00 0.0 0.00 36.75 0.00 1.62 2.62 \n",
11041104
"\n",
11051105
" Shared Energy \n",
11061106
" P1 P2 P3 P4 P5 P6 \n",
1107-
"2024-01-01 12:00:00+01:00 0.0 11.49 21.65 28.86 18.00 20.00 \n",
1108-
"2024-01-01 12:15:00+01:00 0.0 5.87 7.00 15.71 15.71 15.71 \n",
1109-
"2024-01-01 12:30:00+01:00 0.0 10.00 30.00 35.00 19.00 24.00 \n",
1110-
"2024-01-01 12:45:00+01:00 0.0 0.00 3.25 10.00 23.38 23.38 "
1107+
"2024-01-01 11:00:00+00:00 0.0 11.49 21.65 28.86 18.00 20.00 \n",
1108+
"2024-01-01 11:15:00+00:00 0.0 5.87 7.00 15.71 15.71 15.71 \n",
1109+
"2024-01-01 11:30:00+00:00 0.0 10.00 30.00 35.00 19.00 24.00 \n",
1110+
"2024-01-01 11:45:00+00:00 0.0 0.00 3.25 10.00 23.38 23.38 "
11111111
]
11121112
},
11131113
"execution_count": 12,
@@ -1156,10 +1156,10 @@
11561156
"{\n",
11571157
" \"netInjection\": {\n",
11581158
" \"index\": [\n",
1159-
" \"2024-01-01T12:00:00+01:00\",\n",
1160-
" \"2024-01-01T12:15:00+01:00\",\n",
1161-
" \"2024-01-01T12:30:00+01:00\",\n",
1162-
" \"2024-01-01T12:45:00+01:00\"\n",
1159+
" \"2024-01-01T11:00:00Z\",\n",
1160+
" \"2024-01-01T11:15:00Z\",\n",
1161+
" \"2024-01-01T11:30:00Z\",\n",
1162+
" \"2024-01-01T11:45:00Z\"\n",
11631163
" ],\n",
11641164
" \"columns\": [\n",
11651165
" \"P1\",\n",
@@ -1206,10 +1206,10 @@
12061206
" },\n",
12071207
" \"netOfftake\": {\n",
12081208
" \"index\": [\n",
1209-
" \"2024-01-01T12:00:00+01:00\",\n",
1210-
" \"2024-01-01T12:15:00+01:00\",\n",
1211-
" \"2024-01-01T12:30:00+01:00\",\n",
1212-
" \"2024-01-01T12:45:00+01:00\"\n",
1209+
" \"2024-01-01T11:00:00Z\",\n",
1210+
" \"2024-01-01T11:15:00Z\",\n",
1211+
" \"2024-01-01T11:30:00Z\",\n",
1212+
" \"2024-01-01T11:45:00Z\"\n",
12131213
" ],\n",
12141214
" \"columns\": [\n",
12151215
" \"P1\",\n",
@@ -1256,10 +1256,10 @@
12561256
" },\n",
12571257
" \"sharedEnergy\": {\n",
12581258
" \"index\": [\n",
1259-
" \"2024-01-01T12:00:00+01:00\",\n",
1260-
" \"2024-01-01T12:15:00+01:00\",\n",
1261-
" \"2024-01-01T12:30:00+01:00\",\n",
1262-
" \"2024-01-01T12:45:00+01:00\"\n",
1259+
" \"2024-01-01T11:00:00Z\",\n",
1260+
" \"2024-01-01T11:15:00Z\",\n",
1261+
" \"2024-01-01T11:30:00Z\",\n",
1262+
" \"2024-01-01T11:45:00Z\"\n",
12631263
" ],\n",
12641264
" \"columns\": [\n",
12651265
" \"P1\",\n",

‎openenergyid/__init__.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""Open Energy ID Python SDK."""
22

3-
__version__ = "0.1.12"
3+
__version__ = "0.1.13"
44

55
from .enums import Granularity
66
from .models import TimeDataFrame, TimeSeries

‎openenergyid/energysharing/__init__.py‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
"""Energy Sharing package."""
22

33
from .main import calculate
4-
from .models import CalculationMethod, EnergySharingInput, EnergySharingOutput
4+
from .models import CalculationMethod, EnergySharingInput, EnergySharingOutput, KeyInput
55

6-
__all__ = ["calculate", "CalculationMethod", "EnergySharingInput", "EnergySharingOutput"]
6+
__all__ = [
7+
"calculate",
8+
"CalculationMethod",
9+
"EnergySharingInput",
10+
"EnergySharingOutput",
11+
"KeyInput",
12+
]

‎openenergyid/energysharing/data_formatting.py‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,6 @@ def create_multi_index_input_frame(
2222

2323
df = pd.concat([gross_injection, gross_offtake, key], axis=1)
2424

25-
# Do a check that the sum of the keys per timestamp is 1
26-
assert df[KEY].dropna(how="all").sum(axis=1).round(2).eq(1).all()
27-
2825
return df
2926

3027

0 commit comments

Comments
 (0)