Skip to content

Installation

Goal

Install PyFLASH in the Python environment you will use for analysis.

Before You Start

  • PyFLASH requires Python 3.9 or newer.
  • The package name on PyPI is PyFLASH-analysis.
  • The import name in Python is PyFLASH.

Steps

Install the released package:

python -m pip install PyFLASH-analysis

For local development from this repository, install the editable package from the project root:

python -m pip install -e .

Install the optional Streamlit UI dependencies only when you want the UI:

python -m pip install -e ".[ui]"

If you installed from PyPI and want the UI extra, use:

python -m pip install "PyFLASH-analysis[ui]"

Check It Worked

Run a small import check in the same environment:

python -c "from PyFLASH import create_batch, from_dataframe, run_spec; print('PyFLASH import ok')"

The command should print PyFLASH import ok.

Next