Skip to main content

Owl - Optimal Wealth Lab: Retirement planner with great wisdom

Project description

Owl - Optimal Wealth Lab

Tests GitHub release PyPI Python License: GPL v3 Streamlit App

A retirement exploration tool based on mixed-integer linear programming


TL;DR

Owl is a retirement financial planning tool that uses a mixed-integer linear programming optimization algorithm to provide guidance on retirement decisions such as contributions, withdrawals, Roth conversions, and more. 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.

Owl is designed for US retirees as it considers US federal tax laws, ACA marketplace premiums (pre-65), Medicare premiums, rules for 401k including required minimum distributions, maturation rules for Roth accounts and conversions, social security rules, etc.

There are three ways to run Owl (from easiest to more complex):

  1. Streamlit Hub: Run Owl remotely as hosted on the Streamlit Community Cloud at owlplanner.streamlit.app.

  2. Docker Container: Run Owl locally on your computer using a Docker image. Follow these instructions for using this option.

  3. Self-hosting: Run Owl locally on your computer using Python code and libraries. Follow these instructions to install from the source code and self-host on your own computer.


Documentation

Document Description
INSTALL.md Installation guide, Python environment setup, and developer build steps
USER_GUIDE.md Python API usage with examples for Jupyter notebooks and scripts
PARAMETERS.md Complete reference for TOML case file parameters
RATE_MODELS.md Available rate models (historical, stochastic, bootstrap, etc.)
docs/modeling-capabilities.md Summary of modeled components, assumptions, and limitations
papers/owl.pdf Mathematical foundations

Documentation for the app user interface is also available from the Streamlit UI.


Credits and Acknowledgements

See CREDITS.md.

Bugs and Feature Requests

Please submit bugs and feature requests through GitHub if you have a GitHub account or directly by email. Or just drop me a line to report your experience with the tool.

Privacy

This app does not store or forward any information. All data entered is lost after a session is closed. However, you can choose to download selected parts of your own data to your computer before closing the session. These data will be stored strictly on your computer and can be used to reproduce a case at a later time.


Copyright © 2024-2026 - Martin-D. Lacasse

Disclaimers: This code is for educational purposes only and does not constitute financial advice.

Code output has been verified with analytical solutions when applicable, and comparative approaches otherwise. Nevertheless, accuracy of results is not guaranteed.


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

owlplanner-2026.4.6.tar.gz (6.6 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

owlplanner-2026.4.6-py3-none-any.whl (241.3 kB view details)

Uploaded Python 3

File details

Details for the file owlplanner-2026.4.6.tar.gz.

File metadata

  • Download URL: owlplanner-2026.4.6.tar.gz
  • Upload date:
  • Size: 6.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.9

File hashes

Hashes for owlplanner-2026.4.6.tar.gz
Algorithm Hash digest
SHA256 9953d6a2a91d8d810de5307a052057d430a7d866a0c38cd9523b56b12bbb0573
MD5 4af8851d85d9bb6230ade3d04a3cff8e
BLAKE2b-256 85e1031716d81bb7ca39983526a8470327f73c5af681ae2e4c5d74677d145e41

See more details on using hashes here.

File details

Details for the file owlplanner-2026.4.6-py3-none-any.whl.

File metadata

  • Download URL: owlplanner-2026.4.6-py3-none-any.whl
  • Upload date:
  • Size: 241.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.9

File hashes

Hashes for owlplanner-2026.4.6-py3-none-any.whl
Algorithm Hash digest
SHA256 46d92b6d7921318514c3ace221138338a9adbd757ff68f7c52bfe1cbcfec4ab1
MD5 471c7cdce57085cf1cf210899c44c9cb
BLAKE2b-256 60e0b63ac7dc3fde56d592abe24289ceba6e65106ab61271f077721e48ff49a9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page