owlplanner 2025.2.27__tar.gz → 2025.3.11__tar.gz

{owlplanner-2025.2.27 → owlplanner-2025.3.11}/.github/workflows/github-actions-runtests.yml

@@ -5,6 +5,7 @@ name: Python package
 
 run-name: ${{ github.actor }} running tests
 on: [push]
+permissions: read-all
 jobs:
   build:
     runs-on: ubuntu-latest

{owlplanner-2025.2.27 → owlplanner-2025.3.11}/INSTALL.md

@@ -14,7 +14,7 @@ or, if one prefers to have everything on their own computer,
 to install and run a Docker image as described in these [instructions](docker/README.md).
 
 ### Requirements
-You will need Python and `pip` installed on your computer for that purpose.
+You will need Python and `pip` installed on your computer for completing the installation.
 
 ### Installation steps for developers
 These instructions are command-line instructions.
@@ -29,7 +29,8 @@ From the top directory of the source code run:
 python -m build 
 pip install -e .
 ```
-The -e instructs Python to load the live version in the current directory tree. 
+The -e instructs `pip` to install in *editable* mode and use the live version
+in the current directory tree.
 
 ### Running the streamlit frontend 
 Running the Owl user interface locally from Windows:
@@ -42,7 +43,7 @@ Running the Owl user interface locally from Linux or MacOS:
 ```
 
 ### Publishing a version (for reference only)
-Run checks before commit:
+Run checks before all commits:
 ```
 flake8 ui src tests
 pytest

{owlplanner-2025.2.27 → owlplanner-2025.3.11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: owlplanner
-Version: 2025.2.27
+Version: 2025.3.11
 Summary: Owl: Retirement planner with great wisdom
 Project-URL: HomePage, https://github.com/mdlacasse/owl
 Project-URL: Repository, https://github.com/mdlacasse/owl
@@ -711,7 +711,13 @@ Description-Content-Type: text/markdown
 -------------------------------------------------------------------------------------
 
 ### TL;DR
-Owl is a planning tool that uses a linear programming optimization algorithm to provide guidance on retirement decisions. There are a few ways to run Owl.
+Owl is a retirement planning tool that uses a linear programming optimization algorithm
+to provide guidance on retirement decisions, including Roth conversions.
+Users can select varying return rates to perform historical back testing,
+stochastic rates for performing Monte Carlo analyses,
+or fixed rates either derived from historical averages, or set by the user.
+
+There are a few ways to run Owl:
 
 - Run Owl directly on the Streamlit Community Server at [owlplanner.streamlit.app](https://owlplanner.streamlit.app).
 
@@ -759,7 +765,7 @@ mathematical model can be found [here](https://raw.github.com/mdlacasse/Owl/main
 It is anticipated that most end users will use Owl through the graphical interface
 either at [owlplanner.streamlit.app](https://owlplanner.streamlit.app)
 or [installed](INSTALL.md) on their own computer.
-The underlying Python package can also be used directly through Python scripts or a Jupyter Notebook
+The underlying Python package can also be used directly through Python scripts or Jupyter Notebooks
 as described [here](USER_GUIDE.md).
 
 Not every retirement decision strategy can be framed as an easy-to-solve optimization problem.
@@ -792,7 +798,7 @@ Asset allocations are selected for the duration of the plan, and these can glide
 or along a configurable s-curve over the lifespan of the individual.
 
 Spending profiles are adjusted for inflation, and so are all other indexable quantities. Proflies can be
-flat or follow a *smile* curve which is also adjustable through two simple parameters.
+flat or follow a *smile* curve which is also adjustable through three simple parameters.
 
 Available rates are from 1928 to last year and can be used to test historical performance.
 Fixed rates can also be provided, as well as *histochastic* rates, which are generated using
@@ -868,7 +874,7 @@ assets to support, even with no estate being left.
 ---------------------------------------------------------------
 ## Documentation
 
-- Documentation for the app user interface is available from the interface itself.
+- Documentation for the app user interface is available from the interface [itself](https://owlplanner.streamlit.app/Documentation).
 - Installation guide and software requirements can be found [here](INSTALL.md).
 - User guide for the underlying Python package as used in a Jupyter notebook can be found [here](USER_GUIDE.md).