festim-gui

GUI for FESTIM

License

This library is OpenSource and follow the MIT License

Installation

Install the application/library

pip install festim-gui

Run the application

festim-gui

Development setup

We recommend using uv for setting up and managing a virtual environment for your development.

# Create venv and install all dependencies
uv sync --all-extras --dev

# Activate environment
source .venv/bin/activate

# Install commit analysis
pre-commit install
pre-commit install --hook-type commit-msg

For running tests and checks, you can run nox.

# run all
nox

# lint
nox -s lint

# tests
nox -s tests

Docker

Build the Docker image from the repository root:

docker build -t festim-gui .

Run the image and expose it on port 8080:

docker run -it --rm -p 8080:80 festim-gui

Then open http://localhost:8080/ in your browser.

Docker setup files are located under setup/.

Professional Support

• Training: Learn how to confidently use trame from the expert developers at Kitware.
• Support: Our experts can assist your team as you build your web application and establish in-house expertise.
• Custom Development: Leverage Kitware’s 25+ years of experience to quickly build your web application.