Skip to main content

sfincstools

Command-line tools for inspecting and monitoring SFINCS models.

Installation

pip install -e .

Tools

sfpgs — check the progress of a SFINCS run

sfpgs [MODEL_DIR] [--watch SECONDS] [--stall MINUTES]
  • MODEL_DIR – folder with sfincs.inp (default: current folder)
  • --watch – refresh every SECONDS until the run ends (default: report once)
  • --stall – warn if the log has not changed for this many minutes (default 10)

Reads sfincs.log / sfincs_log.txt (percent complete, remaining time, errors, summary) and the last time stamp in sfincs_map.nc / sfincs_his.nc. Safe to run while SFINCS is running.

sfcfg — display the configuration of a SFINCS model

sfcfg [MODEL_DIR] [--plot] [--save FILE.png]
  • MODEL_DIR – folder with sfincs.inp (default: current folder)
  • --plot – also show a map (bed level, mask, boundary, drainage, weirs, obs) and the forcing time series
  • --save – write the figure to a file instead of opening a window

Reports sfincs.inp grouped by topic with derived values, the presence/size of every referenced input file, and a short summary of each file's contents.

Python usage

from sfincstools import sfpgs, sfcfg

sfpgs.main(["path/to/model"])
sfcfg.main(["path/to/model", "--save", "model.png"])

Metadata

Release files for sfincstools 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sfincstools 0.1.0
File Size Uploaded Provenance Actions
sfincstools-0.1.0.tar.gz 14.7 kB With provenance Details for sfincstools-0.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for sfincstools 0.1.0
File Interpreter ABI Platform Actions
sfincstools-0.1.0-py3-none-any.whl Python 3 none any Details for sfincstools-0.1.0-py3-none-any.whl

Total release size: 29.1 kB

Release files / sfincstools-0.1.0.tar.gz

Download URL sfincstools-0.1.0.tar.gz
Size 14.7 kB
Tags Source
SHA-256 checksum
How to use checksums
199c1f1f9505541324deb83b301d7c5b22661ae5981eac740133646a01aa1ece
BLAKE2b-256 checksum
How to use checksums
38e1b9c83e6378a9ff092f164dfd04c8bd4980946aeabd9440c0ba636e9561f8
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 15, 2026.

Transparency log

Release files / sfincstools-0.1.0-py3-none-any.whl

Download URL sfincstools-0.1.0-py3-none-any.whl
Size 14.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
cb0f3e65a6e8d492ff180554fc49ee4689b110e0aca778877b65af428da6dd9f
BLAKE2b-256 checksum
How to use checksums
a08b53748dc950add48c9dfe906a30f9782aff56e386b598131e6cf945189132
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 15, 2026.

Transparency log

Security for sfincstools 0.1.0

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.

Select from 2 files

Attestation for sfincstools-0.1.0.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 15, 2026.

Transparency log

A 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.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page