Merge pull request #11 from daniel-fink/develop

Develop
daniel-fink · Jun 21, 2022 · 4483fb5 · 4483fb5
2 parents 29b7775 + 8f8b33f
commit 4483fb5
Show file tree

Hide file tree

Showing 40 changed files with 2,270 additions and 914 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,20 @@
-# rangekeeper
-A Python library assisting financial modelling in scenario planning, decision-making, cashflow forecasting, and the like 
+# Rangekeeper
+Rangekeeper is a library assisting financial modelling in real estate scenario planning, decision-making, cashflow forecasting, and the like.
+
+It decomposes elements of the Discounted Cash Flow (DCF) Proforma modelling approach into recomposable code functions that can be wired together to form a full model. More elaborate and worked-through examples of these classes and functions will be documented in a forthcoming Jupyter Book to be found in the `/notebooks` directory.
+
+Development of the library follows the rigorous methodology established by Profs Geltner and de Neufville in their book [Flexibility and Real Estate Valuation under Uncertainty: A Practical Guide for Developers](https://doi.org/10.1002/9781119106470)
+
+## Dependencies:
+
+- Python >= 3.9 & < 3.11
+
+- Poetry: <https://python-poetry.org/>, a package manager (although it is possible to roll your own; YMMV)
+
+## Installation
+
+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`
diff --git a/__init__.py b/__init__.py
diff --git a/conftest.py b/conftest.py
@@ -0,0 +1,2 @@
+import sys
+sys.path.append("./rangekeeper")
diff --git a/dynamics/__init__.py b/dynamics/__init__.py
diff --git a/measure.py b/measure.py
diff --git a/models/__init__.py b/models/__init__.py