Skip to main content

Parsli is a VTK+trame based viewer for fault system kinematics that enables fast exploration and export of time animation.

Project description

parsli

Actions Status PyPI version PyPI platforms PyPI download

Introduction

Parsli is a VTK+trame based viewer for fault system kinematics that enables fast exploration and export of time animation.

Getting started

First you should setup a virtual environment for this Python Application. You can use conda, uv or anything else for managing your Python runtime. For the following commands, we will be using uv with Python 3.10.

uv venv -p 3.10
source .venv/bin/activate
uv pip install parsli

Once your environment is loaded, you can start the viewer by running the following command:

# use remote rendering
python -m parsli.viewer --data ./data/model_0000000881_multi.hdf5

# use wasm for local rendering
python -m parsli.viewer --data ./data/model_0000000881_multi.hdf5 --wasm

# use shorthand executable
parsli --data ./data/model_0000000881_multi.hdf5

App

Keyboard binding

  • left/right/up/down arrow: Rotate camera by 1°. Modifier x5 <alt>.
  • -/+: Zoom out / Zoom in.
  • r: Reset camera to data
  • t: Snap view up to true vertical.
  • f: Focus to the mesh bounds
  • home: Go to first timestep
  • end: Go to last timestep
  • space: Toggle play/stop animation
  • </>: Previous/Next timestep. Modifiers x10 alt or shift, x100 alt+shift.

Once you've exported a couple of time animations, you can play them back using the player. Just add all the paths you want to see after the --data argument.

parsli-player --data ./export/dip_slip ./export/strike_slip ./export/dip_slip_formula ./export/strike_slip_formula

Player

Keyboard binding

  • right arrow: Go to next timestep
  • left arrow: Go to previous timestep
  • home: Go to first timestep
  • end: Go to last timestep
  • space: Toggle play/stop animation

Development setup

We assume your virtual environment is activated

uv pip install -e ".[dev]"
pre-commit install

This will automatically format and some static checking on the code at commit time, but you can also run it by hand using the following command line.

pre-commit run --all-files

Nox can also be used for running tests or linting the code.

# run everything
nox

# run just the linting
nox -s lint

Commit message convention

Semantic release rely on conventional commits to generate new releases and changelog.

Project details


Download files

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

Source Distribution

parsli-1.2.3.tar.gz (57.0 kB view details)

Uploaded Source

Built Distribution

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

parsli-1.2.3-py3-none-any.whl (66.4 kB view details)

Uploaded Python 3

File details

Details for the file parsli-1.2.3.tar.gz.

File metadata

  • Download URL: parsli-1.2.3.tar.gz
  • Upload date:
  • Size: 57.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for parsli-1.2.3.tar.gz
Algorithm Hash digest
SHA256 5fdf167e29a95dd01721681fff1ae83f860eb7e1134d599ff3da000eb6a130ed
MD5 80ab9daa11e1623d9a7c27acb0680424
BLAKE2b-256 660bab20f38053d0b3ba144b287e0a1bc1d03f05ced8597dab42000602c0c2e8

See more details on using hashes here.

Provenance

The following attestation bundles were made for parsli-1.2.3.tar.gz:

Publisher: test_and_release.yml on brendanjmeade/parsli

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

File details

Details for the file parsli-1.2.3-py3-none-any.whl.

File metadata

  • Download URL: parsli-1.2.3-py3-none-any.whl
  • Upload date:
  • Size: 66.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for parsli-1.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 18c636a78f3f8a1bf2a78156e5829aedd9a9c5d02ed27676bb9431223f7c22a6
MD5 d6b05f1368ff52247f8eaa976747c47d
BLAKE2b-256 7d81b829d951134aff802a433af2f76d6d307d3babb7649e1ab0d64976e6be86

See more details on using hashes here.

Provenance

The following attestation bundles were made for parsli-1.2.3-py3-none-any.whl:

Publisher: test_and_release.yml on brendanjmeade/parsli

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 Pingdom Monitoring Sentry Error logging StatusPage Status page