
PyFRB/US is a Python-based simulation platform for the FRB/US model.

The PyFRB/US package requires Python 3 and can be installed by running `pip install -e .`
or `pip3 install -e .` from the root directory of this package.
Python dependencies are listed in setup.py and should be automatically installed.
If `scikit-umfpack` is installed, it will be used to speed up solution times under certain conditions, but it is not required.

On Windows, it is suggested to install and run PyFRB/US via the Windows Subsystem
for Linux (WSL). See the PyFRB/US User Guide for details.

PyFRB/US is only compatible with Python version 3.9 or greater.
Compatibility has been tested up to Python 3.14 (inclusive), but cannot be guaranteed for later Python versions.

To access the PyFRB/US documentation, open docs/index.html in a web browser.

Demo programs can be found under the demos/ folder.
Demos expect the data/ folder to contain the LONGBASE.TXT dataset, which can be copied
over from the data_only_package.

==================
CHANGELOG
==================

1.1.1
------------------
 * Bug fixes, updated documentation, improved error messages
 * Removed dependency on `scikit_umfpack` for ease of install
 * Updated dependency to pandas>=2.1.0,<3.0.0

1.1
------------------
 * Bug fixes, performance improvements, updated documentation
 * Added capability for Jacobian re-use
 * Trim stochsim output to sim end period by default to save memory
 * Fix mislabeled chart: output from sim_plot was erroneously labeled "Quarterly Annualized" instead of "4-Quarter Percent Change"

1.0
------------------
 * Initial release.