FPy

An embedded Python DSL for specifying and simulating numerical algorithms.

Important links:

• PyPI package: fpy2
• Documentation: fpy.readthedocs.io
• GitHub: fpy

Installation

The recommended way to install FPy is through pip. FPy can also be installed from source for development. The following instructions assume a bash-like shell.

Installing with pip

Requirements:

• Python 3.11 or later

To install the latest stable release of FPy, run:

pip install fpy2

Installing from source

Requirements:

• Python 3.11 or later
• make

Installation

If you do not have a Python virtual environment, create one using

python3 -m venv .env/

and activate it using using

source .env/bin/activate

To install an instance of FPy for development, run:

pip install -e .[dev]

or with make, run

make install-dev

To uninstall FPy, run:

pip uninstall fpy2

Testing

There are a number of tests that can be run through the Makefile including

make lint

to ensure formatting and type safety;

make unittest

to run the unit tests;

make infratest

to run the infrastructure tests.