pepflow 0.1.7

PEPFlow: A framework for Performance Estimation Problem (PEP) Workflow

PEPFlow: Performance Estimation Problem Workflow

TODO

Development Guide

We use uv to manage the packages and python enviromnents. To start

uv sync; source .venv/bin/activate;

In windows, use .venv\Scripts\activate instead.

Lint & Testing

We use ruff to do the format and lint and isort to do the import ordering.

ruff format;
ruff check .;
isort .;

We use pytest framework to do the test. To run all unit tests, run the following command:

pytest -s -vv pepflow

We have a convenient script to above

scripts/check.sh [format|lint|typecheck|test]

See the script for the options.

Build doc website

Install the required library (one-time) and pandoc in order to build ipynb.

pip install -r docs/requirements.txt

To build the website, run

scripts/build_doc.sh [--serve-only]

The argument --serve-only is optional for hosting the website locally.