quadros is a Python CLI package for rendering snapshots into checked frame sets and videos. It can run locally, over SSH, inside containers, or from scheduler jobs without copying scripts into case directories. Nek5000 is the format with dedicated support; other VTK-readable formats are supported via PyVista.
Features
- Render one snapshot or a globbed case directory of snapshots (Nek5000 with dedicated support).
- Keep JSON render configs compatible with the original
auto_snpworkflow. - Write manifests, logs, events, frames, and encoded movies under a run output directory.
- Inspect render manifests before deleting dense snapshots.
- Extract camera settings from ParaView
.pvsmstate files. - Gate NekStab omega-R renders with explicit field aliases and a rebuild hint.
Install
With uv (recommended for local development)
git clone https://github.com/openfluids/quadros.git
cd quadros
uv venv .venv
. .venv/bin/activate
uv pip install -e .
quadros doctor
For development tools and tests:
uv pip install -e . --group dev
python -m pytest
With standard venv + pip
git clone https://github.com/openfluids/quadros.git
cd quadros
python -m venv .venv
. .venv/bin/activate
python -m pip install --upgrade pip
python -m pip install -e .
quadros doctor
For development tools and tests:
python -m pip install -e . pytest build twine
python -m pytest
For a cluster/native rendering setup, see docs/native-stack.md.
CLI
quadros doctor
quadros render snapshot.f00001 --config configs/render_scenes_example.json
quadros render-many --case-dir /path/to/case --pattern 'sphere0.f*' --config render.json
quadros inspect manifest.json
quadros encode --frames frames/ --out movies/movie.mp4
quadros extract-camera qp_comp.pvsm --out camera.json
By default, render outputs are written in loco under SNAPSHOT_PARENT/quadros for render and CASE_DIR/quadros for render-many. Use --out only when you intentionally want a different output root.
--check enables an omega-R preflight gate for configs that declare field_aliases for omR*/omega fields. If the configured payload is absent, the command points the operator to rebuild the NekStab case with ifvox = .true. and mks <CASE>.
Package layout
src/quadros/— importable package and public CLI entrypoint.configs/— JSON render config examples compatible with the original workflow.slurm/render_snapshots.sbatch— generic Slurm starter template; copy it and add cluster-specific account, partition, module, or container directives as needed.tests/— packaging and CLI smoke tests.docs/— native-stack notes and operating guidance.PLAN.md— source migration plan.
Validation
python -m compileall src tests
python -m quadros --help
quadros doctor
Disclaimer
This software is provided "as is", without warranty of any kind. To the extent permitted by law, the authors and contributors are not liable for any damage, loss or claim arising from its use or misuse. You are responsible for how you use it and for following the laws and rules that apply to you. The full terms are in LICENSE.
This is research software. It has not been validated for engineering design, certification or safety-critical use. Check its results independently before you rely on them.
Metadata
Release files for quadros 0.1.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| quadros-0.1.3.tar.gz | 47.7 kB | With provenance | Details for quadros-0.1.3.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| quadros-0.1.3-py3-none-any.whl | Python 3 | none | any | Details for quadros-0.1.3-py3-none-any.whl |
Total release size: 90.0 kB
Release files / quadros-0.1.3.tar.gz
| Download URL | quadros-0.1.3.tar.gz |
|---|---|
| Size | 47.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
88817a4d0f026e90f03e3c90532c57cda9f699d5b44fab843b9c38c5669fdfd9
|
|
BLAKE2b-256 checksum How to use checksums |
f3b60bc04d8c64ae18ef7a26160a0b8a1ed80c9de49f8f42ea24c3e195846999
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 13, 2026.
Transparency logRelease files / quadros-0.1.3-py3-none-any.whl
| Download URL | quadros-0.1.3-py3-none-any.whl |
|---|---|
| Size | 42.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
606e0b5f414ed48dfb6578de9ab3605dc07df395f9d8e705038b55f7ea97cfbf
|
|
BLAKE2b-256 checksum How to use checksums |
309f0c7dd04b4f38c2f4ec2ddea372b38667595080b6d95e18562f1cf3cfe46d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 13, 2026.
Transparency logSecurity for quadros 0.1.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for quadros-0.1.3.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 13, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.