Installation

Requirements

In the near future, FORGE will be available on PyPI for easy installation via pip. In the meantime, you can install it directly from the source code:

git clone https://github.com/FORGExhaust/FORGE.git
cd forge
pip install .

For an editable (development) install:

pip install -e .

FORGE includes an optional graphical user interface built with Panel and Bokeh. To install the GUI dependencies:

pip install ".[gui]"

Or, for an editable install with GUI support:

pip install -e ".[gui]"

Once installed, launch the GUI with:

forge-gui

See the GUI page for full usage instructions.

pip install ".[test]"
pytest

pip install ".[docs]"
cd docs
make html

Then open build/html/index.html in your browser.