sfincstools
Command-line tools for building, 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 withsfincs.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 withsfincs.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.
sfclr — remove the files generated by a SFINCS run
sfclr [MODEL_DIR] [--yes] [--post] [--recursive] [--move-to DIR]
MODEL_DIR– model folder with a*.inp(default: current folder)-y,--yes– actually delete (default is a dry run that only lists the files)--post– also remove post-processing products (sfincs_hmax*.tif/.png, animations)-r,--recursive– clean every folder below MODEL_DIR that contains a*.inp--move-to DIR– move the files into DIR (relative to each model folder) instead of deleting
Removes NetCDF map / his output, run logs, restart output and binary / ascii output.
Files referenced in a *.inp (e.g. a restart file used as input) are never removed.
sfgen — build a sfincs.inp in a desktop GUI
sfgen [SOURCE] [--out-dir DIR]
SOURCE–.xlsx(one sheet per group) or.inpto load at start, or a model folder (itssfincs.inp); default:inp_prep.xlsxin the current folder if it exists, else the built-in defaults--out-dir DIR– output folder for the generated.inp/.bat(default: the folder of an.inpSOURCE, else the current folder)
One tab per parameter group with every SFINCS keyword; tick a keyword to write it. Preview / Generate
check the time settings and warn about missing input files and duplicate or unsupported keywords.
Optionally writes a run_<name>.bat that starts sfincs.exe.
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.2.0
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 |
|---|---|---|---|---|
| sfincstools-0.2.0.tar.gz | 33.1 kB | With provenance | Details for sfincstools-0.2.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| sfincstools-0.2.0-py3-none-any.whl | Python 3 | none | any | Details for sfincstools-0.2.0-py3-none-any.whl |
Total release size: 65.4 kB
Release files / sfincstools-0.2.0.tar.gz
| Download URL | sfincstools-0.2.0.tar.gz |
|---|---|
| Size | 33.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5426d292e6118c4858e7e43e2f98434b96f5d486acf4c4d14854b57b38d6c80f
|
|
BLAKE2b-256 checksum How to use checksums |
91d877177c2dccbbf8ae0b6398454c7a79f56cc86446f4fc85c92b36a61bce18
|
| 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 16, 2026.
Transparency logRelease files / sfincstools-0.2.0-py3-none-any.whl
| Download URL | sfincstools-0.2.0-py3-none-any.whl |
|---|---|
| Size | 32.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
14cd4b6c8344599af6ebc7b643d978033cee6c60795be7a202096d60283e6cc7
|
|
BLAKE2b-256 checksum How to use checksums |
6be05a7c2d1326ee7ce5693d02055a9c9cac95617da8dc900ba6354d71ea8e95
|
| 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 16, 2026.
Transparency logSecurity for sfincstools 0.2.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.
Attestation for sfincstools-0.2.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 16, 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.