owlplanner 2025.4.7__tar.gz → 2025.4.22__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/INSTALL.md +24 -15
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/PKG-INFO +1 -1
- owlplanner-2025.4.22/Papers/BF01580653.pdf +0 -0
- owlplanner-2025.4.22/Papers/Snyder-LinearProgrammingSpecial-1984.pdf +0 -0
- owlplanner-2025.4.22/Papers/WileyModelBuildinginMathematicalProgramming5th2013.sharethefiles.com.pdf +0 -0
- owlplanner-2025.4.22/docs/newowl.tex +1356 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/docs/owl.pdf +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/notebooks/john+sally.ipynb +96 -96
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/pyproject.toml +1 -1
- owlplanner-2025.4.22/src/owlplanner/.plan.py.swo +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/src/owlplanner/plan.py +5 -5
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/src/owlplanner/tax2025.py +3 -2
- owlplanner-2025.4.22/src/owlplanner/version.py +1 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/ui/About_Owl.py +8 -7
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/ui/Documentation.py +53 -8
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/ui/Optimization_Parameters.py +2 -2
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/ui/owlbridge.py +16 -8
- owlplanner-2025.4.22/ui/requirements.txt +10 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/ui/sskeys.py +3 -3
- owlplanner-2025.4.7/src/owlplanner/version.py +0 -1
- owlplanner-2025.4.7/ui/requirements.txt +0 -11
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/.devcontainer/devcontainer.json +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/.flake8 +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/.gitattributes +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/.github/workflows/github-actions-runtests.yml +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/.gitignore +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/LICENSE +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/Papers/FE00006821-Class-VI-Injection-Permit--Salient-Features-and-Regulatory-Challenges_Final.pdf +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/Papers/Kou-OptionPricingDouble-2004.pdf +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/Papers/Multi-Period Mean Expected-Shortfall Strategies Cut Your Losses and Ride Your Gains .pdf +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/Papers/Optimal Asset Allocation for Retirement Saving Deterministic Vs. Time Consistent Adaptive Strategies.pdf +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/Papers/Rule-based_strategies_for_dynamic_life_cycle_inves.pdf +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/Papers/bv_cvxbook.pdf +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/Papers/s10436-006-0062-y.pdf +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/README.md +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/USER_GUIDE.md +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/docker/Dockerfile +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/docker/README.md +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/docker/docker-compose.yml +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/docker/fastentrypoint.sh +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/docs/images/AD-taxDef.png +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/docs/images/AD-taxFree.png +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/docs/images/AD-taxable.png +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/docs/images/Hist_Bequest.png +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/docs/images/Hist_Spending.png +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/docs/images/MC-tutorial2a.png +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/docs/images/MC-tutorial2b.png +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/docs/images/OwlUI.png +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/docs/images/allocations.png +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/docs/images/owl.png +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/docs/images/profile.png +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/docs/images/ratesCorrelations.png +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/docs/images/ratesPlot.png +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/docs/images/savingsPlot.png +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/docs/images/sourcesPlot.png +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/docs/images/spendingPlot.png +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/docs/images/taxIncomePlot.png +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/docs/images/taxesPlot.png +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/docs/owl.tex +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/examples/case_jack+jill.toml +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/examples/case_joe.toml +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/examples/case_john+sally.toml +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/examples/case_jon+jane.toml +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/examples/case_kim+sam-bequest.toml +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/examples/case_kim+sam-spending.toml +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/examples/jack+jill.xlsx +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/examples/joe.xlsx +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/examples/john+sally.xlsx +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/examples/jon+jane.xlsx +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/examples/template.xlsx +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/notebooks/kim+sam.ipynb +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/notebooks/template.ipynb +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/notebooks/tutorial_1.ipynb +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/notebooks/tutorial_2.ipynb +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/notebooks/tutorial_3.ipynb +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/owlplanner.cmd +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/owlplanner.sh +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/reponse.txt +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/requirements.txt +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/src/owlplanner/__init__.py +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/src/owlplanner/abcapi.py +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/src/owlplanner/config.py +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/src/owlplanner/data/__init__.py +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/src/owlplanner/data/rates.csv +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/src/owlplanner/logging.py +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/src/owlplanner/progress.py +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/src/owlplanner/rates.py +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/src/owlplanner/timelists.py +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/src/owlplanner/utils.py +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/tests/test_logger.py +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/tests/test_regressions.py +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/tests/test_repro.py +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/tests/test_toml_cases.py +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/tests/test_units.py +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/ttt.py +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/ttt2.py +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/ttt3.py +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/ui/Asset_Allocation.py +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/ui/Create_Case.py +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/ui/Current_Assets.py +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/ui/Fixed_Income.py +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/ui/Graphs.py +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/ui/Historical_Range.py +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/ui/Logs.py +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/ui/Monte_Carlo.py +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/ui/Output_Files.py +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/ui/Quick_Start.py +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/ui/README.md +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/ui/Rates_Selection.py +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/ui/Settings.py +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/ui/Wages_And_Contributions.py +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/ui/Worksheets.py +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/ui/main+fonts.py +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/ui/main.py +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/ui/plots.py +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/ui/progress.py +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/ui/sskeys.py.color +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/ui/style.css +0 -0
- {owlplanner-2025.4.7 → owlplanner-2025.4.22}/ui/tomlexamples.py +0 -0
|
@@ -15,24 +15,23 @@ to install and run a Docker image as described in these [instructions](docker/RE
|
|
|
15
15
|
|
|
16
16
|
### Requirements
|
|
17
17
|
You will need Python and `pip` installed on your computer for completing the installation.
|
|
18
|
+
These instructions are command-line instructions run from a terminal window.
|
|
18
19
|
|
|
19
|
-
### Installation steps for
|
|
20
|
-
These instructions are command-line instructions.
|
|
20
|
+
### Installation steps for Python package only
|
|
21
21
|
You will need the latest version of Owl from GitHub.
|
|
22
22
|
```shell
|
|
23
23
|
git clone https://github.com/mdlacasse/Owl.git
|
|
24
24
|
|
|
25
25
|
```
|
|
26
|
-
|
|
26
|
+
Then go (`cd`) to the directory where you installed Owl.
|
|
27
|
+
You can install the Owl package directly from the [Python Package Index](http://pypi.org).
|
|
27
28
|
From the top directory of the source code run:
|
|
29
|
+
The following command will install the current version of owlplanner and all its dependencies:
|
|
28
30
|
```shell
|
|
29
|
-
|
|
30
|
-
pip install -e .
|
|
31
|
+
pip install -r ui/requirements.txt
|
|
31
32
|
```
|
|
32
|
-
The -e instructs `pip` to install in *editable* mode and use the live version
|
|
33
|
-
in the current directory tree.
|
|
34
33
|
|
|
35
|
-
### Running the streamlit frontend
|
|
34
|
+
### Running the streamlit frontend locally
|
|
36
35
|
Running the Owl user interface locally from Windows:
|
|
37
36
|
```shell
|
|
38
37
|
./owlplanner.cmd
|
|
@@ -41,6 +40,23 @@ Running the Owl user interface locally from Linux or MacOS:
|
|
|
41
40
|
```shell
|
|
42
41
|
./owlplanner.sh
|
|
43
42
|
```
|
|
43
|
+
This will open a tab on your default browser.
|
|
44
|
+
|
|
45
|
+
### Installation steps for developers
|
|
46
|
+
These instructions are command-line instructions.
|
|
47
|
+
You will need the latest version of Owl from GitHub.
|
|
48
|
+
```shell
|
|
49
|
+
git clone https://github.com/mdlacasse/Owl.git
|
|
50
|
+
|
|
51
|
+
```
|
|
52
|
+
Go (`cd`) to the directory where you installed Owl.
|
|
53
|
+
From the top directory of the source code run:
|
|
54
|
+
```shell
|
|
55
|
+
python -m build
|
|
56
|
+
pip install -e .
|
|
57
|
+
```
|
|
58
|
+
The -e instructs `pip` to install in *editable* mode and use the live version
|
|
59
|
+
in the current directory tree.
|
|
44
60
|
|
|
45
61
|
### Publishing a version (for reference only)
|
|
46
62
|
Run checks before all commits:
|
|
@@ -56,10 +72,3 @@ twine upload --repository [repo] dist/*
|
|
|
56
72
|
```
|
|
57
73
|
where [repo] is *testpypi* or *pypi* depending on the type of release.
|
|
58
74
|
|
|
59
|
-
### Installation steps for Python package only
|
|
60
|
-
You can install the Owl package directly from the [Python Package Index](http://pypi.org).
|
|
61
|
-
The following command will install the current version of owlplanner and all its dependencies:
|
|
62
|
-
```shell
|
|
63
|
-
pip install -r ui/requirements.txt
|
|
64
|
-
```
|
|
65
|
-
|
|
Binary file
|
|
Binary file
|