Rangekeeper 0.8.31__tar.gz → 0.8.33__tar.gz

{rangekeeper-0.8.31 → rangekeeper-0.8.33}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Rangekeeper
-Version: 0.8.31
+Version: 0.8.33
 Summary: A Python library assisting financial modelling in real estate asset & development planning, decision-making, cashflow forecasting, and scenario analysis.
 Author-email: Daniel Fink <danfink@mit.edu>
 License-Expression: MPL-2.0

{rangekeeper-0.8.31 → rangekeeper-0.8.33}/Rangekeeper.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Rangekeeper
-Version: 0.8.31
+Version: 0.8.33
 Summary: A Python library assisting financial modelling in real estate asset & development planning, decision-making, cashflow forecasting, and scenario analysis.
 Author-email: Daniel Fink <danfink@mit.edu>
 License-Expression: MPL-2.0

{rangekeeper-0.8.31 → rangekeeper-0.8.33}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "Rangekeeper"
-version = "0.8.31"
+version = "0.8.33"
 description = "A Python library assisting financial modelling in real estate asset & development planning, decision-making, cashflow forecasting, and scenario analysis."
 authors = [
     { name = "Daniel Fink", email = "danfink@mit.edu" }

{rangekeeper-0.8.31 → rangekeeper-0.8.33}/rangekeeper/flux.py

@@ -272,9 +272,9 @@ class Flow:
 
         return cls(movements=movements, units=units, name=name)
 
-    def invert(self) -> Flow:
+    def negate(self) -> Flow:
         """
-        Returns a Flow with movement values inverted (multiplied by -1)
+        Returns a Flow with movement values negated (multiplied by -1)
         """
         return self.__class__(
             movements=self.movements.copy(deep=True).multiply(-1),
@@ -384,6 +384,7 @@ class Flow:
     def resample(
         self,
         frequency: rk.duration.Type,
+        origin: Optional[Union[str, pd.Timestamp]] = "end_day",
     ) -> Flow:
         """
         Returns a Flow with movements summed to specified frequency of periods
@@ -393,7 +394,7 @@ class Flow:
             .resample(
                 rule=rk.duration.Type.offset(frequency),
                 label="right",
-                origin="end_day",
+                origin=origin,
             )
             .sum(),
             units=self.units,
@@ -403,13 +404,20 @@ class Flow:
     def to_periods(
         self,
         frequency: rk.duration.Type,
+        origin: Optional[Union[str, pd.Timestamp]] = "end_day",
     ) -> pd.Series:
         """
         Returns a pd.Series (of index pd.PeriodIndex) with movements summed to specified frequency
         """
         return (
-            self.resample(frequency=frequency)
-            .movements.to_period(freq=rk.duration.Type.period(frequency), copy=True)
+            self.resample(
+                frequency=frequency,
+                origin=origin,
+            )
+            .movements.to_period(
+                freq=rk.duration.Type.period(frequency),
+                copy=True,
+            )
             .rename_axis("period")
             .groupby(level="period")
             .sum()
@@ -543,7 +551,11 @@ class Stream:
         """The latest date of the Stream's constituent Flows' movements."""
 
         self._resampled_flows = [
-            flow.to_periods(frequency=self.frequency) for flow in self.flows
+            flow.to_periods(
+                frequency=self.frequency,
+                origin=self.start_date,
+            )
+            for flow in self.flows
         ]
         self.frame = (
             pd.concat(

{rangekeeper-0.8.31 → rangekeeper-0.8.33}/tests/test_dynamics.py

@@ -108,7 +108,7 @@ class ExAnteInflexibleModel:
             name="Operating Expenses",
             movements=self.pgi.movements * params["opex_pgi_ratio"],
             units=currency.units,
-        ).invert()
+        ).negate()
         self.noi = rk.flux.Stream(
             name="Net Operating Income",
             flows=[self.egi, self.opex],
@@ -118,7 +118,7 @@ class ExAnteInflexibleModel:
             name="Capital Expenditures",
             movements=self.pgi.movements * params["capex_pgi_ratio"],
             units=currency.units,
-        ).invert()
+        ).negate()
         self.net_cfs = rk.flux.Stream(
             name="Net Annual Cashflows",
             flows=[self.noi, self.capex],
@@ -264,7 +264,7 @@ class ExPostInflexibleModel:
             name="Operating Expenses",
             movements=self.pgi.movements * self.params["opex_pgi_ratio"],
             units=currency.units,
-        ).invert()
+        ).negate()
         self.noi = rk.flux.Stream(
             name="Net Operating Income",
             flows=[self.egi, self.opex],
@@ -274,7 +274,7 @@ class ExPostInflexibleModel:
             name="Capital Expenditures",
             movements=self.pgi.movements * self.params["capex_pgi_ratio"],
             units=currency.units,
-        ).invert()
+        ).negate()
         self.net_cfs = rk.flux.Stream(
             name="Net Annual Cashflows",
             flows=[self.noi, self.capex],

{rangekeeper-0.8.31 → rangekeeper-0.8.33}/tests/test_formulas.py

@@ -100,8 +100,8 @@ class Model:
             starting=0,
             transactions=rk.flux.Stream(
                 flows=[
-                    self.equity.overdraft.diff().invert(),
-                    self.payments.invert(),
+                    self.equity.overdraft.diff().negate(),
+                    self.payments.negate(),
                 ],
                 frequency=self.params["frequency"],
             ).sum(),
@@ -252,7 +252,7 @@ class TestFinancial:
                 data=transactions,
                 sequence=sequence,
                 units=currency.units,
-            ).invert(),
+            ).negate(),
             frequency=self.params["frequency"],
             type=rk.formula.financial.Account.Type.SIMPLE,
             rate=rate,
@@ -277,7 +277,7 @@ class TestFinancial:
     def test_capitalized_interest(self):
         account = rk.formula.financial.Account(
             starting=0,
-            transactions=self.model.draws.sum().invert(),
+            transactions=self.model.draws.sum().negate(),
             frequency=self.params["frequency"],
             type=rk.formula.financial.Account.Type.CAPITALIZED,
             rate=self.params["interest_rate_pa"]
@@ -297,8 +297,8 @@ class TestFinancial:
         transactions = rk.flux.Stream(
             name="Transactions",
             flows=[
-                self.model.draws.sum().invert(),
-                self.model.payments.invert(),
+                self.model.draws.sum().negate(),
+                self.model.payments.negate(),
             ],
             frequency=self.params["frequency"],
         )
@@ -326,13 +326,13 @@ class TestFinancial:
     def test_balances(self):
         transactions = rk.flux.Stream(
             name="Transactions",
-            flows=[self.model.draws.sum().invert()],
+            flows=[self.model.draws.sum().negate()],
             frequency=self.params["frequency"],
         )
 
         equity = rk.formula.financial.Account(
             starting=176631.99,
-            transactions=transactions.sum().invert(),
+            transactions=transactions.sum().negate(),
             frequency=self.params["frequency"],
             type=rk.formula.financial.Account.Type.SIMPLE,
             name="Equity Account",
@@ -349,8 +349,8 @@ class TestFinancial:
             starting=0,
             transactions=rk.flux.Stream(
                 flows=[
-                    equity.overdraft.diff().invert(),
-                    self.model.payments.invert(),
+                    equity.overdraft.diff().negate(),
+                    self.model.payments.negate(),
                 ],
                 frequency=self.params["frequency"],
             ).sum(),
@@ -369,7 +369,7 @@ class TestFinancial:
         profit = rk.flux.Stream(
             flows=[
                 equity.diff(),
-                loan.overdraft.diff().invert(),
+                loan.overdraft.diff().negate(),
             ],
             frequency=self.params["frequency"],
             name="Profit",

{rangekeeper-0.8.31 → rangekeeper-0.8.33}/tests/test_modules.py

@@ -204,7 +204,7 @@ class TestFlow:
         assert collapse.movements.size == 1
         assert collapse.movements.array[0] == 100.0
 
-    invert_flow = flow.invert()
+    invert_flow = flow.negate()
 
     def test_flow_inversion(self):
         # TestFlow.invert_flow.display()
@@ -330,7 +330,8 @@ class TestStream:
         assert TestStream.stream.frame.index.freqstr == "M"
 
         product = TestStream.stream.product(
-            name="product", registry=units, scope=dict(globals(), **locals())
+            name="product",
+            registry=units,
         )
         product.display()
 
@@ -358,7 +359,8 @@ class TestStream:
         )
 
         stream_sqm_agg = stream_sqm.product(
-            name="stream_sqm_agg", scope=scope, registry=units
+            name="stream_sqm_agg",
+            registry=units,
         )
 
         assert stream_sqm_agg.units == "AUD * squaremeter"