rangekeeper 0.7.7__tar.gz → 0.7.9__tar.gz

{rangekeeper-0.7.7 → rangekeeper-0.7.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Rangekeeper
-Version: 0.7.7
+Version: 0.7.9
 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
@@ -30,16 +30,23 @@ This directory holds the source code for the Rangekeeper Library
 
 ## Installation
 The library is offered through PyPI, and so its installation in other projects can be performed by:
-`pip install rangekeeper` or `poetry add rangekeeper`
+`pip install rangekeeper`, `poetry add rangekeeper`, or `uv add rangekeeper`, depending on your virtual environment manager.
 
 ## Development
-If you wish to contribute to its development, it is recommended to use [Poetry](https://python-poetry.org/) for environment and dependency management:
+If you wish to contribute to its development, it is recommended to use [uv](https://docs.astral.sh/uv/) for 
+environment and dependency management:
 
 ### Environment Setup
 
-1. Install poetry, if you haven't yet: <https://python-poetry.org/docs/master/#installing-with-the-official-installer>
+1. Install uv, if you haven't yet: <https://docs.astral.sh/uv/>
 2. Clone this repo.
-3. Use a terminal to install poetry packages from the repo's directory: `<path_to_repo>$ poetry install`
-4. If you wish to develop this repo alongside other projects locally, you may install the local Rangekeeper library via `<path_to_repo>$ poetry run pip install -e <path_to_rangekeeper_repo>`,
-replacing `<path_to_rangekeeper_repo>` with its location on your system.
-5. Some tests require API access to [Speckle](https://speckle.systems/). It is recommended to use the [Poetry Dotenv Plugin](https://github.com/mpeteuil/poetry-dotenv-plugin) via `poetry self add poetry-dotenv-plugin`, and add a `.env` file in the project's root directory with your `SPECKLE_TOKEN` environment variable.
+3. Create a virtual environment: `uv venv .venv`
+4. Activate the virtual environment: `source .venv/bin/activate`
+5. Install dependencies: `uv pip install -r <(uv pip compile pyproject.toml)`
+6. Some tests require API access to [Speckle](https://speckle.systems/). It is recommended to use [Python-Dotenv](https://github.com/theskumar/python-dotenv), and add a `.env` file in the project's root directory with your `SPECKLE_TOKEN` environment variable.
+
+### Publishing
+1. First, remove any previously built packages: `rm -rf dist/`
+2. Build the package: `uv build`
+3. Then, publish it to PyPI with your `UV_PUBLISH_TOKEN` recorded in the .env file: `export $(grep -v 
+   '^#' .env | xargs) && uv publish --token $UV_PUBLISH_TOKEN`

rangekeeper-0.7.9/README.md

@@ -0,0 +1,25 @@
+# Rangekeeper Source
+This directory holds the source code for the Rangekeeper Library
+
+## Installation
+The library is offered through PyPI, and so its installation in other projects can be performed by:
+`pip install rangekeeper`, `poetry add rangekeeper`, or `uv add rangekeeper`, depending on your virtual environment manager.
+
+## Development
+If you wish to contribute to its development, it is recommended to use [uv](https://docs.astral.sh/uv/) for 
+environment and dependency management:
+
+### Environment Setup
+
+1. Install uv, if you haven't yet: <https://docs.astral.sh/uv/>
+2. Clone this repo.
+3. Create a virtual environment: `uv venv .venv`
+4. Activate the virtual environment: `source .venv/bin/activate`
+5. Install dependencies: `uv pip install -r <(uv pip compile pyproject.toml)`
+6. Some tests require API access to [Speckle](https://speckle.systems/). It is recommended to use [Python-Dotenv](https://github.com/theskumar/python-dotenv), and add a `.env` file in the project's root directory with your `SPECKLE_TOKEN` environment variable.
+
+### Publishing
+1. First, remove any previously built packages: `rm -rf dist/`
+2. Build the package: `uv build`
+3. Then, publish it to PyPI with your `UV_PUBLISH_TOKEN` recorded in the .env file: `export $(grep -v 
+   '^#' .env | xargs) && uv publish --token $UV_PUBLISH_TOKEN`

{rangekeeper-0.7.7 → rangekeeper-0.7.9}/Rangekeeper.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Rangekeeper
-Version: 0.7.7
+Version: 0.7.9
 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
@@ -30,16 +30,23 @@ This directory holds the source code for the Rangekeeper Library
 
 ## Installation
 The library is offered through PyPI, and so its installation in other projects can be performed by:
-`pip install rangekeeper` or `poetry add rangekeeper`
+`pip install rangekeeper`, `poetry add rangekeeper`, or `uv add rangekeeper`, depending on your virtual environment manager.
 
 ## Development
-If you wish to contribute to its development, it is recommended to use [Poetry](https://python-poetry.org/) for environment and dependency management:
+If you wish to contribute to its development, it is recommended to use [uv](https://docs.astral.sh/uv/) for 
+environment and dependency management:
 
 ### Environment Setup
 
-1. Install poetry, if you haven't yet: <https://python-poetry.org/docs/master/#installing-with-the-official-installer>
+1. Install uv, if you haven't yet: <https://docs.astral.sh/uv/>
 2. Clone this repo.
-3. Use a terminal to install poetry packages from the repo's directory: `<path_to_repo>$ poetry install`
-4. If you wish to develop this repo alongside other projects locally, you may install the local Rangekeeper library via `<path_to_repo>$ poetry run pip install -e <path_to_rangekeeper_repo>`,
-replacing `<path_to_rangekeeper_repo>` with its location on your system.
-5. Some tests require API access to [Speckle](https://speckle.systems/). It is recommended to use the [Poetry Dotenv Plugin](https://github.com/mpeteuil/poetry-dotenv-plugin) via `poetry self add poetry-dotenv-plugin`, and add a `.env` file in the project's root directory with your `SPECKLE_TOKEN` environment variable.
+3. Create a virtual environment: `uv venv .venv`
+4. Activate the virtual environment: `source .venv/bin/activate`
+5. Install dependencies: `uv pip install -r <(uv pip compile pyproject.toml)`
+6. Some tests require API access to [Speckle](https://speckle.systems/). It is recommended to use [Python-Dotenv](https://github.com/theskumar/python-dotenv), and add a `.env` file in the project's root directory with your `SPECKLE_TOKEN` environment variable.
+
+### Publishing
+1. First, remove any previously built packages: `rm -rf dist/`
+2. Build the package: `uv build`
+3. Then, publish it to PyPI with your `UV_PUBLISH_TOKEN` recorded in the .env file: `export $(grep -v 
+   '^#' .env | xargs) && uv publish --token $UV_PUBLISH_TOKEN`

{rangekeeper-0.7.7 → rangekeeper-0.7.9}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "Rangekeeper"
-version = "0.7.7"
+version = "0.7.9"
 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.7.7 → rangekeeper-0.7.9}/rangekeeper/flux.py

@@ -5,7 +5,7 @@ import itertools
 import json
 import locale
 import os
-from typing import Dict, Union, Optional, Tuple
+from typing import Dict, Union, Optional, Tuple, List
 
 import matplotlib.pyplot as plt
 import numpy as np
@@ -19,19 +19,22 @@ import rangekeeper as rk
 def _format_series(
     series: pd.Series,
     units: pint.Unit,
+    to_datestamps: bool = True,
     decimals: int = 2,
 ):
+    index = pd.Series(series.index.date, name="date") if to_datestamps else series.index
+
     if units.dimensionality == "[currency]":
         formatted = pd.Series(
             data=[str(locale.currency(value, grouping=True)) for value in series],
-            index=pd.Series(series.index, name="date"),
+            index=index,
             name=series.name,
         )
     else:
         floatfmt = "{:." + str(decimals) + "f}"
         formatted = pd.Series(
             data=[str(floatfmt.format(value)) for value in series],
-            index=pd.Series(series.index, name="date"),
+            index=index,
             name=series.name,
         )
 
@@ -133,7 +136,9 @@ class Flow:
             "Movements: "
             + os.linesep
             + _format_series(
-                series=self.movements, units=self.units, decimals=decimals
+                series=self.movements,
+                units=self.units,
+                decimals=decimals,
             ).to_markdown(
                 stralign="right",
                 numalign="right",
@@ -393,10 +398,10 @@ class Flow:
 
 class Stream:
     name: str
-    flows: [Flow]
+    flows: List[Flow]
     frequency: rk.duration.Type
-    start_date: pd.Timestamp
-    end_date: pd.Timestamp
+    start_date: datetime.date
+    end_date: datetime.date
     frame: pd.DataFrame
 
     """
@@ -405,7 +410,7 @@ class Stream:
 
     def __init__(
         self,
-        flows: [Flow],
+        flows: List[Flow],
         frequency: rk.duration.Type,
         name: str = None,
     ):
@@ -437,9 +442,9 @@ class Stream:
         self.start_date = min(flows_dates)
         self.end_date = max(flows_dates)
 
-        index = rk.duration.Sequence.from_bounds(
-            include_start=self.start_date, frequency=self.frequency, bound=self.end_date
-        )
+        # index = rk.duration.Sequence.from_bounds(
+        #     include_start=self.start_date, frequency=self.frequency, bound=self.end_date
+        # )
         self._resampled_flows = [
             flow.to_periods(frequency=self.frequency) for flow in self.flows
         ]
@@ -465,10 +470,22 @@ class Stream:
         for flow in self.flows:
             series = flow.to_periods(frequency=self.frequency)
             formatted_flows.append(
-                _format_series(series=series, units=flow.units, decimals=decimals)
+                _format_series(
+                    series=series,
+                    units=flow.units,
+                    to_datestamps=False,
+                    decimals=decimals,
+                )
             )
         # formatted_flows = [flow._format_movements(decimals=decimals) for flow in self._resampled_flows]
-        frame = pd.concat(formatted_flows, axis=1).fillna(0).sort_index()
+        frame = (
+            pd.concat(
+                formatted_flows,
+                axis=1,
+            )
+            .fillna(0)
+            .sort_index()
+        )
         return frame
 
     def display(
@@ -487,7 +504,10 @@ class Stream:
             "Flows: "
             + os.linesep
             + self._format_flows(decimals=decimals).to_markdown(
-                tablefmt=tablefmt, stralign="right", numalign="right", floatfmt=floatfmt
+                tablefmt=tablefmt,
+                stralign="right",
+                numalign="right",
+                floatfmt=floatfmt,
             )
         )
 
@@ -820,7 +840,7 @@ class Stream:
 
     def extend(
         self,
-        flows: [Flow],
+        flows: List[Flow],
     ):
         """
         Returns a new Stream with additional Flows

rangekeeper-0.7.9/rangekeeper/formula/financial.py

@@ -0,0 +1,234 @@
+import enum
+import dataclasses
+import numpy as np
+import numba
+import pandas as pd
+
+import rangekeeper as rk
+
+
+class Balance:
+    startings: rk.flux.Flow
+    endings: rk.flux.Flow
+    overdraft: rk.flux.Flow
+
+    def __init__(
+        self,
+        starting: float,
+        transactions: rk.flux.Flow,
+        frequency: rk.duration.Type,
+        name: str = "",
+    ):
+        """
+        Calculate the balance of a financial account given a starting balance and a series of transactions.
+        Returns an object with the starting and ending balances, as well as the overdraft amount, as `Flow`s.
+        Overdraft is the portion of transactions occurring while the balance is non-positive.
+        """
+
+        transactions = transactions.resample(frequency=frequency)
+
+        result = self._calculate_balance(
+            startings=numba.typed.List([np.float64(starting)]),
+            transactions=numba.typed.List(transactions.movements.to_list()),
+        )
+
+        self.startings = rk.flux.Flow(
+            movements=pd.Series(
+                result[0],
+                index=transactions.movements.index,
+            ),
+            units=transactions.units,
+            name=f"{name} Start Balance",
+        )
+
+        self.endings = rk.flux.Flow(
+            movements=pd.Series(
+                result[1],
+                index=transactions.movements.index,
+            ),
+            units=transactions.units,
+            name=f"{name} End Balance",
+        )
+
+        self.overdraft = rk.flux.Flow(
+            movements=pd.Series(
+                result[2],
+                index=transactions.movements.index,
+            ),
+            units=transactions.units,
+            name=f"{name} Overdraft",
+        )
+
+    @classmethod
+    def from_flows(
+        cls,
+        startings: rk.flux.Flow,
+        endings: rk.flux.Flow,
+        frequency: rk.duration.Type,
+        name: str = "",
+    ):
+        name = startings.name if name is None else name
+        if startings.units != endings.units:
+            raise ValueError("The units of the starting and ending flows must match.")
+        units = startings.units
+
+        startings = startings.resample(frequency=frequency)
+        endings = endings.resample(frequency=frequency)
+
+        transactions = rk.flux.Flow(
+            movements=endings.movements - startings.movements,
+            units=units,
+        )
+        starting = startings.movements.iloc[0]
+
+        return cls(
+            starting=starting,
+            transactions=transactions,
+            frequency=frequency,
+            name=name,
+        )
+
+    @staticmethod
+    @numba.jit
+    def _calculate_balance(
+        startings: numba.typed.List,
+        transactions: numba.typed.List,
+    ) -> (
+        numba.typed.List,
+        numba.typed.List,
+        numba.typed.List,
+    ):
+
+        endings = numba.typed.List.empty_list(numba.float64)
+        overdrafts = numba.typed.List.empty_list(numba.float64)
+        for i in range(len(transactions)):
+            ending = float(startings[-1] + transactions[i])
+
+            overdrafts.append(ending if ending < 0 else 0)
+            endings.append(ending if ending > 0 else 0)
+            startings.append(endings[-1])
+
+        return (
+            startings[:-1],
+            endings,
+            overdrafts,
+        )
+
+
+class Interest:
+    amounts: rk.flux.Flow
+    balance: Balance
+
+    class Type(enum.Enum):
+        INTEREST_ONLY = "interest_only"
+        COMPOUND = "compound"
+        CAPITALIZED = "capitalized"
+
+    def __init__(
+        self,
+        rate: float | rk.flux.Flow,
+        transactions: rk.flux.Flow,
+        frequency: rk.duration.Type,
+        type: Type = Type.COMPOUND,
+    ):
+        """
+        Calculate interest expense on a loan or other interest-bearing liability,
+        described by a series of transactions.
+        Assumes interest is compounded on a positive, outstanding balance per period
+        (i.e. draws are positive, payments are negative).
+        Make sure the rate is consistent with the frequency.
+        """
+
+        transactions = transactions.resample(frequency=frequency)
+
+        if isinstance(rate, float):
+            rate = rk.flux.Flow.from_projection(
+                name="Interest Rates",
+                value=rate,
+                proj=rk.projection.Extrapolation(
+                    form=rk.extrapolation.Recurring(),
+                    sequence=rk.duration.Sequence.from_datestamps(
+                        datestamps=transactions.movements.index, frequency=frequency
+                    ),
+                ),
+            )
+        else:
+            raise NotImplementedError("Only float rates are supported currently.")
+
+        if len(transactions.movements) != len(rate.movements):
+            raise ValueError(
+                "The number of transactions must match the number of rates."
+            )
+
+        startings, endings, amounts = self._calc_interest(
+            transactions=numba.typed.List(transactions.movements.to_list()),
+            rates=numba.typed.List(rate.movements.to_list()),
+            type=type.value,
+        )
+
+        startings = rk.flux.Flow(
+            movements=pd.Series(startings, index=transactions.movements.index),
+            units=transactions.units,
+        )
+        endings = rk.flux.Flow(
+            movements=pd.Series(endings, index=transactions.movements.index),
+            units=transactions.units,
+        )
+
+        self.balance = rk.formula.financial.Balance.from_flows(
+            startings=startings,
+            endings=endings,
+            frequency=frequency,
+        )
+
+        self.amounts = rk.flux.Flow(
+            movements=pd.Series(amounts, index=transactions.movements.index),
+            units=transactions.units,
+            name="Interest",
+        )
+
+    @staticmethod
+    @numba.jit
+    def _calc_interest(
+        transactions: numba.typed.List,
+        rates: numba.typed.List,
+        type: str,
+    ) -> (
+        numba.typed.List,
+        numba.typed.List,
+        numba.typed.List,
+    ):
+
+        startings = numba.typed.List.empty_list(numba.float64)
+        endings = numba.typed.List.empty_list(numba.float64)
+        amounts = numba.typed.List.empty_list(numba.float64)
+
+        for i in range(len(transactions)):
+            if i == 0:
+                startings.append(0)
+            else:
+                startings.append(endings[-1])
+
+            principal = startings[i] + transactions[i]
+            if type == "interest_only":
+                interest = principal * rates[i] if principal > 0 else 0
+                endings.append(principal)
+
+            elif type == "compound":
+                interest = principal * rates[i] if principal > 0 else 0
+                endings.append(principal + interest)
+
+            elif type == "capitalized":
+                # Since we are capitalizing interest, the amount (draw) must include interest to pay on the principal.
+                # Derived from i = r * (P + i)
+                interest = (
+                    (principal * rates[i]) / (1 - rates[i]) if principal > 0 else 0
+                )
+                endings.append(principal + interest)
+
+            else:
+                raise ValueError(f"Invalid instrument: {type}")
+
+            amounts.append(interest)
+
+        return (startings, endings, amounts)

{rangekeeper-0.7.7 → rangekeeper-0.7.9}/tests/test_api.py

@@ -1,90 +1,93 @@
 from __future__ import annotations
 
-import json
-import pprint as pp
 # Pytests file.
 # Note: gathers tests according to a naming convention.
 # By default any file that is to contain tests must be named starting with 'test_',
 # classes that hold tests must be named starting with 'Test',
 # and any function in a file that should be treated as a test must also start with 'test_'.
 import os
-import locale
-import multiprocess as mp
-from typing import List, Callable, Dict
-
-import matplotlib
-import matplotlib.pyplot as plt
-import networkx as nx
-from pyvis.network import Network
-import plotly.express as px
-import plotly.graph_objects as go
+import pprint as pp
+
 # In addition, in order to enable pytest to find all modules,
 # run tests via a 'python -m pytest tests/<test_file>.py' command from the root directory of this project
 import pandas as pd
-pd.set_option('display.max_columns', None)
-import numpy as np
-import scipy.stats as ss
-import pint
+
+pd.set_option("display.max_columns", None)
 
 import rangekeeper as rk
 
 
 class TestApi:
     stream_id = "c0f66c35e3"
-    speckle = rk.api.Speckle(token=os.getenv('SPECKLE_TOKEN'))
+    speckle = rk.api.Speckle(token=os.getenv("SPECKLE_TOKEN"))
     model = speckle.get_commit(stream_id=stream_id)
 
     def test_connection(self):
-        latest_commit_id = TestApi.speckle.get_latest_commit_id(stream_id=TestApi.stream_id)
-        print('Latest Commit: {0}'.format(latest_commit_id))
+        latest_commit_id = TestApi.speckle.get_latest_commit_id(
+            stream_id=TestApi.stream_id
+        )
+        print("Latest Commit: {0}".format(latest_commit_id))
 
         metadata = TestApi.speckle.get_metadata(stream_id=TestApi.stream_id)
         print(metadata)
 
-        assert metadata.name == 'RangekeeperDemo'
+        assert metadata.name == "RangekeeperDemo"
 
         roots = TestApi.model.get_dynamic_member_names()
 
         assert len(roots) == 2
-        assert '@property' in roots
+        assert "@property" in roots
 
     def test_conversion(self):
-        parsed = rk.api.Speckle.parse(base=TestApi.model['@property'])
+        parsed = rk.api.Speckle.parse(base=TestApi.model["@property"])
         root_base = list(parsed.values())[0]
-        print('Root Base:\n {0}'.format(root_base))
-        assert root_base.speckle_type == 'Rangekeeper.Entity:Rangekeeper.Assembly'
+        print("Root Base:\n {0}".format(root_base))
+        assert root_base.speckle_type == "Rangekeeper.Entity:Rangekeeper.Assembly"
 
         root_entity = rk.graph.Entity.from_base(root_base)
-        assert root_entity.name == 'property'
+        assert root_entity.name == "property"
         assert len(root_entity.graph.nodes) == 5
         assert type(root_entity) == rk.graph.Assembly
-        print('Root Entity:\n {0}'.format(root_entity))
-
-        buildingA = [node for node in root_entity.graph.nodes if node.name == 'buildingA'][0]
-        print('BuildingA:\n {0}'.format(buildingA))
-        buildingA_containment = buildingA.get_relatives(outgoing=True, relationship_type='contains')
-        print('BuildingA Containment: \n {0}\n'.format(buildingA_containment))
-
-        buildingAresidential = [node for node in buildingA.graph.nodes if node.name == 'buildingAresidential'][0]
-        print('BuildingAresidential:\n {0}'.format(buildingAresidential))
+        print("Root Entity:\n {0}".format(root_entity))
+
+        buildingA = [
+            node for node in root_entity.graph.nodes if node.name == "buildingA"
+        ][0]
+        print("BuildingA:\n {0}".format(buildingA))
+        buildingA_containment = buildingA.get_relatives(
+            outgoing=True, relationship_type="contains"
+        )
+        print("BuildingA Containment: \n {0}\n".format(buildingA_containment))
+
+        buildingAresidential = [
+            node
+            for node in buildingA.graph.nodes
+            if node.name == "buildingAresidential"
+        ][0]
+        print("BuildingAresidential:\n {0}".format(buildingAresidential))
 
     def test_develop(self):
-        parsed = rk.api.Speckle.parse(base=TestApi.model['@property'])
+        parsed = rk.api.Speckle.parse(base=TestApi.model["@property"])
         # print('\nParsed: \n{0}'.format(pp.pprint([base['name'] for base in parsed.values()])))
         # print('\nCount Parsed: \n{0}'.format(len(parsed)))
 
         property = rk.api.Speckle.to_rk(
-            bases=list(parsed.values()),
-            name='property',
-            type='property')
+            bases=list(parsed.values()), name="property", type="property"
+        )
         # print('\nScenario: \n{0}'.format(scenario))
         # print('\nCount Scenario: \n{0}'.format(len(scenario.graph.nodes())))
 
         spatial_containment = rk.graph.Assembly.from_graph(
             graph=property.graph.edge_subgraph(
-                [edge for edge in property.graph.edges(keys=True) if edge[2] == 'spatiallyContains']),
-            name='spatial_containment',
-            type='subgraph')
+                [
+                    edge
+                    for edge in property.graph.edges(keys=True)
+                    if edge[2] == "spatiallyContains"
+                ]
+            ),
+            name="spatial_containment",
+            type="subgraph",
+        )
         # print('\nSpatial Containment: \n{0}'.format(spatial_containment))
 
         roots = property.get_roots()  # ['spatiallyContains']
@@ -93,7 +96,11 @@ class TestApi:
         subassemblies = property.get_subassemblies()
         # print('\nSubassemblies: \n{0}'.format(pp.pprint(list(subassemblies.values()))))
 
-        buildingA = [assembly for assembly in subassemblies.values() if assembly['name'] == 'buildingA'][0]
+        buildingA = [
+            assembly
+            for assembly in subassemblies.values()
+            if assembly["name"] == "buildingA"
+        ][0]
         # print('\nBuildingA: \n{0}'.format(buildingA))
 
         subentities = buildingA.get_subentities()
@@ -106,27 +113,26 @@ class TestApi:
             hierarchical_layout=False,
             display=False,
             height=1600,
-            )
+        )
 
         spatial_containment_dict = spatial_containment.to_dict()
         # print('\nSpatial Containment Dict: \n{0}'.format(pp.pprint(spatial_containment_dict)))
 
-        spatial_containment.aggregate(
-            property='gfa',
-            label='subtotal_gfa')
+        spatial_containment.aggregate(property="gfa", label="subtotal_gfa")
 
-        print('\nGFA Aggregation: \n{0}'.format(pp.pprint(spatial_containment.to_dict())))
+        print(
+            "\nGFA Aggregation: \n{0}".format(pp.pprint(spatial_containment.to_dict()))
+        )
         #
-        df = pd.DataFrame.from_dict(spatial_containment.to_dict(), orient='index')
+        df = pd.DataFrame.from_dict(spatial_containment.to_dict(), orient="index")
         print(df)
 
         foo = spatial_containment.to_DataFrame()
         #
 
-        fig = spatial_containment.sunburst('subtotal_gfa')
+        fig = spatial_containment.sunburst("subtotal_gfa")
         fig.show()
 
-
         #
 
         #

{rangekeeper-0.7.7 → rangekeeper-0.7.9}/tests/test_formulas.py

@@ -95,7 +95,7 @@ class Model:
             frequency=self.params["frequency"],
         )
 
-        self.overdraft = self.equity.overdraft()
+        self.overdraft = self.equity.overdraft
 
         self.interest = rk.formula.financial.Interest(
             rate=self.params["interest_rate_pa"]
@@ -122,7 +122,9 @@ class TestFinancial:
         draws_periods=9,
         payments=value,
         payments_start_date=rk.duration.offset(
-            date=start_date, duration=rk.duration.Type.MONTH, amount=9
+            date=start_date,
+            duration=rk.duration.Type.MONTH,
+            amount=9,
         ),
         payments_periods=3,
     )
@@ -145,6 +147,10 @@ class TestFinancial:
             frequency=self.params["frequency"],
         )
 
+        interest.balance.startings.display()
+        interest.balance.endings.display()
+        interest.amounts.display()
+
         assert interest.balance.endings.movements.iloc[-1] == approx(525580.95)
         assert interest.amounts.total() == approx(25580.95)
 
@@ -177,11 +183,13 @@ class TestFinancial:
             frequency=self.params["frequency"],
             type=rk.formula.financial.Interest.Type.CAPITALIZED,
         )
-        assert interest.balance.endings.movements.iloc[-1] == approx(510577.82)
-        assert interest.amounts.total() == approx(10577.82)
+        # assert interest.balance.endings.movements.iloc[-1] == approx(510577.82)
+        # assert interest.amounts.total() == approx(10577.82)
 
         interest.balance.startings.display()
         interest.balance.endings.display()
+        interest.amounts.display()
+        interest.balance.overdraft.display()
 
     def test_balance(self):
         transactions = rk.flux.Stream(
@@ -196,7 +204,9 @@ class TestFinancial:
             frequency=self.params["frequency"],
             type=rk.formula.financial.Interest.Type.CAPITALIZED,
         )
-        assert interest.balance.endings.movements.iloc[-1] == approx(-488680.57)
+        interest.balance.overdraft.display()
+        assert interest.balance.overdraft.movements.iloc[-1] == approx(-333333.33)
+        assert interest.balance.overdraft.total() == approx(-488680.57)
         assert interest.amounts.total() == approx(11319.43)
 
         interest.balance.startings.display()
@@ -206,9 +216,7 @@ class TestFinancial:
     def test_balances(self):
         transactions = rk.flux.Stream(
             name="Transactions",
-            flows=[
-                self.model.draws.sum().invert(),
-            ],
+            flows=[self.model.draws.sum().invert()],
             frequency=self.params["frequency"],
         )
         equity = rk.formula.financial.Balance(
@@ -221,14 +229,17 @@ class TestFinancial:
         equity.startings.display()
         equity.endings.display()
 
-        overdraft = equity.overdraft()
+        overdraft = equity.overdraft
         overdraft.display()
 
         interest = rk.formula.financial.Interest(
             rate=self.params["interest_rate_pa"]
             / rk.duration.Period.yearly_count((self.params["frequency"])),
             transactions=rk.flux.Stream(
-                flows=[overdraft.invert(), self.model.payments.invert()],
+                flows=[
+                    overdraft.invert(),
+                    self.model.payments.invert(),
+                ],
                 frequency=self.params["frequency"],
             ).sum(),
             frequency=self.params["frequency"],
@@ -239,7 +250,8 @@ class TestFinancial:
         interest.amounts.display()
         print(interest.amounts.total())
 
-        profit = interest.balance.overdraft(name="Profit").invert()
+        profit = interest.balance.overdraft.invert()
+        profit.name = "Profit"
         profit.display()
 
         assert profit.total() == approx(671969.16)

rangekeeper-0.7.7/README.md

@@ -1,18 +0,0 @@
-# Rangekeeper Source
-This directory holds the source code for the Rangekeeper Library
-
-## Installation
-The library is offered through PyPI, and so its installation in other projects can be performed by:
-`pip install rangekeeper` or `poetry add rangekeeper`
-
-## Development
-If you wish to contribute to its development, it is recommended to use [Poetry](https://python-poetry.org/) for environment and dependency management:
-
-### Environment Setup
-
-1. Install poetry, if you haven't yet: <https://python-poetry.org/docs/master/#installing-with-the-official-installer>
-2. Clone this repo.
-3. Use a terminal to install poetry packages from the repo's directory: `<path_to_repo>$ poetry install`
-4. If you wish to develop this repo alongside other projects locally, you may install the local Rangekeeper library via `<path_to_repo>$ poetry run pip install -e <path_to_rangekeeper_repo>`,
-replacing `<path_to_rangekeeper_repo>` with its location on your system.
-5. Some tests require API access to [Speckle](https://speckle.systems/). It is recommended to use the [Poetry Dotenv Plugin](https://github.com/mpeteuil/poetry-dotenv-plugin) via `poetry self add poetry-dotenv-plugin`, and add a `.env` file in the project's root directory with your `SPECKLE_TOKEN` environment variable.

rangekeeper-0.7.7/rangekeeper/formula/financial.py

@@ -1,189 +0,0 @@
-import enum
-import dataclasses
-import numpy as np
-import numba
-import pandas as pd
-
-import rangekeeper as rk
-
-
-class Balance:
-    startings: rk.flux.Flow
-    endings: rk.flux.Flow
-
-    def __init__(
-            self,
-            starting: float,
-            transactions: rk.flux.Flow,
-            frequency: rk.duration.Type,
-    ):
-        """
-        Calculate the balance of a financial account given a starting balance and a series of transactions.
-        """
-
-        transactions = transactions.resample(frequency=frequency)
-
-        result = self._calculate_balance(
-            startings=numba.typed.List([np.float64(starting)]),
-            transactions=numba.typed.List(transactions.movements.to_list()))
-
-        self.startings=rk.flux.Flow(
-            movements=pd.Series(result[0], index=transactions.movements.index),
-            units=transactions.units,
-            name='Start Balance')
-
-        self.endings=rk.flux.Flow(
-            movements=pd.Series(result[1], index=transactions.movements.index),
-            units=transactions.units,
-            name='End Balance')
-
-    @classmethod
-    def from_flows(
-            cls,
-            startings: rk.flux.Flow,
-            endings: rk.flux.Flow,
-    ):
-        balance = super().__new__(cls)
-        balance.startings = startings
-        balance.endings = endings
-
-        return balance
-
-    def overdraft(
-            self,
-            name: str = None,
-    ) -> rk.flux.Flow:
-        """
-        Identifies the portion of transactions occurring while the balance is negative.
-        """
-
-        starts = self.startings.movements.where(self.startings.movements < 0).fillna(0)
-        ends = self.endings.movements.where(self.endings.movements < 0).fillna(0)
-
-        overdrafts = ends - starts
-        overdrafts = overdrafts.where(overdrafts < 0).dropna()
-
-        return rk.flux.Flow(
-            movements=overdrafts,
-            units=self.startings.units,
-            name='Overdraft' if name is None else name)
-
-
-    @staticmethod
-    @numba.jit
-    def _calculate_balance(
-            startings: numba.typed.List,
-            transactions: numba.typed.List) -> (numba.typed.List, numba.typed.List):
-
-        endings = numba.typed.List.empty_list(numba.float64)
-        for i in range(len(transactions)):
-            endings.append(float(startings[-1] + transactions[i]))
-            startings.append(endings[-1])
-
-        return (startings[:-1], endings)
-
-
-class Interest:
-    amounts: rk.flux.Flow
-    balance: Balance
-
-    class Type(enum.Enum):
-        INTEREST_ONLY = 'interest_only'
-        COMPOUND = 'compound'
-        CAPITALIZED = 'capitalized'
-
-    def __init__(
-            self,
-            rate: float | rk.flux.Flow,
-            transactions: rk.flux.Flow,
-            frequency: rk.duration.Type,
-            type: Type = Type.COMPOUND,
-    ):
-        """
-        Calculate interest expense on a loan or other interest-bearing liability,
-        described by a series of transactions.
-        Assumes interest is compounded on a positive, outstanding balance per period
-        (i.e. draws are positive, payments are negative).
-        Make sure the rate is consistent with the frequency.
-        """
-
-        transactions = transactions.resample(frequency=frequency)
-
-        if isinstance(rate, float):
-            rate = rk.flux.Flow.from_projection(
-                name='Interest Rates',
-                value=rate,
-                proj=rk.projection.Extrapolation(
-                    form=rk.extrapolation.Recurring(),
-                    sequence=rk.duration.Sequence.from_datestamps(
-                        datestamps=transactions.movements.index,
-                        frequency=frequency)))
-        else:
-            raise NotImplementedError('Only float rates are supported currently.')
-
-        if len(transactions.movements) != len(rate.movements):
-            raise ValueError('The number of transactions must match the number of rates.')
-
-        startings, endings, interests = self._calc_interest(
-            transactions=numba.typed.List(transactions.movements.to_list()),
-            rates=numba.typed.List(rate.movements.to_list()),
-            type=type.value)
-
-        self.balance = rk.formula.financial.Balance.from_flows(
-            startings=rk.flux.Flow(
-                movements=pd.Series(startings, index=transactions.movements.index),
-                units=transactions.units,
-                name='Start Balance'),
-            endings=rk.flux.Flow(
-                movements=pd.Series(endings, index=transactions.movements.index),
-                units=transactions.units,
-                name='End Balance')
-        )
-
-        self.amounts = rk.flux.Flow(
-            movements=pd.Series(interests, index=transactions.movements.index),
-            units=transactions.units,
-            name='Interest')
-
-
-    @staticmethod
-    @numba.jit
-    def _calc_interest(
-            transactions: numba.typed.List,
-            rates: numba.typed.List,
-            type: str,
-    ) -> (numba.typed.List, numba.typed.List, numba.typed.List):
-
-        startings = numba.typed.List.empty_list(numba.float64)
-        endings = numba.typed.List.empty_list(numba.float64)
-        amounts = numba.typed.List.empty_list(numba.float64)
-
-        for i in range(len(transactions)):
-            if i == 0:
-                startings.append(0)
-            else:
-                startings.append(endings[-1])
-
-            principal = startings[i] + transactions[i]
-            if type == 'interest_only':
-                interest = principal * rates[i] if principal > 0 else 0
-                endings.append(principal)
-
-            elif type == 'compound':
-                interest = principal * rates[i] if principal > 0 else 0
-                endings.append(principal + interest)
-
-            elif type == 'capitalized':
-                interest = (principal * rates[i]) / (1 - rates[i]) if principal > 0 else 0 # Since we are capitalizing
-                # interest, the amount (draw) must include interest to pay on the principal. Derived from i = r * (P + i)
-                endings.append(principal + interest)
-
-            else:
-                raise ValueError(f'Invalid instrument: {type}')
-
-            amounts.append(interest)
-
-        return (startings, endings, amounts)
-
-
-