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

Simulation runs

The Run page uses FESTIM_GUI_PYTHON to execute generated scripts, falling back to the interpreter running festim-gui. The Docker image configures this variable automatically. Outside Docker, install festim in the active environment or set the variable to an interpreter that provides it.

Simulation working directories are created under the system temporary directory (e.g. /tmp).

Each run gets its own temporary directory containing the generated script, a run.log file, and any simulation outputs written by the script.

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

For development, you can mount the source code into the container:

docker run -it --rm -p 8080:80 -v .:/local-app festim-gui

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

The Docker image includes festim, so Run page executions work inside the container without any extra local FESTIM installation.

Docker setup files are located under setup/.

GPU support

The post-processing view can render either on the client or on the server:

  • Local rendering (default) – geometry is sent to the browser and rendered in browser. No GPU is needed on the server.

  • Remote rendering (GPU) – ParaView renders on the server and streams images to the browser. This requires a GPU available to the process, and is enabled with the --gpu flag.

The Docker image exposes both modes as separate apps, declared in setup/apps.yml:

  • http://localhost:8080/index.html – default app, local rendering.

  • http://localhost:8080/gpu.html – same app launched with --gpu, remote rendering.

Running the container with GPUs

Install the NVIDIA Container Toolkit on the host, then pass the GPUs to the container with --gpus:

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

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

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.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for will.dunklin from gravatar.com will.dunklin

Credits

Author: Kitware, Inc.

License

MIT License (MIT License)

Requires

Python >=3.10

Provides Extra

app dev jupyter

Tags

Application Framework Interactive Python Web

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

festim_gui-1.3.0.tar.gz (24.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

festim_gui-1.3.0-py3-none-any.whl (38.0 kB view details)

Uploaded Python 3

File details

Details for the file festim_gui-1.3.0.tar.gz.

File metadata

  • Download URL: festim_gui-1.3.0.tar.gz
  • Upload date:
  • Size: 24.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for festim_gui-1.3.0.tar.gz
Algorithm Hash digest
SHA256 4ee3a372756b3651ff335342eaabe2643eb74e0b44bba2041ae493064f1dffb9
MD5 145b7b12a75260f8e86bcb9c3c683214
BLAKE2b-256 9a50903901be3473c8f8a44f04561c304e527820ba7fee1f71b31b841da15f9b

See more details on using hashes here.

Provenance

The following attestation bundles were made for festim_gui-1.3.0.tar.gz:

Publisher: test_and_release.yml on festim-dev/festim-gui

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file festim_gui-1.3.0-py3-none-any.whl.

File metadata

  • Download URL: festim_gui-1.3.0-py3-none-any.whl
  • Upload date:
  • Size: 38.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for festim_gui-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0914a34b8af5db0d66282475c42e6cf03a6e9213b11287c0b6a51e9ec73dae1e
MD5 40869ee50a2cec509a8acc9e8d86a422
BLAKE2b-256 d4594ece36821833dfd77f6cef6808a93d8002143bdbf594484653a2bb1a57bc

See more details on using hashes here.

Provenance

The following attestation bundles were made for festim_gui-1.3.0-py3-none-any.whl:

Publisher: test_and_release.yml on festim-dev/festim-gui

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page