Simvue Python client
Collect metadata, metrics and artifacts from simulations, processing and AI/ML training tasks running on any platform, in real time.
Configuration
The service URL and token can be defined as environment variables:
export SIMVUE_URL=...
export SIMVUE_TOKEN=...
or a file simvue.toml can be created containing:
[server]
url = "..."
token = "..."
The exact contents of both of the above options can be obtained directly by clicking the Create new run button on the web UI. Note that the environment variables have preference over the config file.
Usage example
from simvue import Run
...
if __name__ == "__main__":
...
# Using a context manager means that the status will be set to completed automatically,
# and also means that if the code exits with an exception this will be reported to Simvue
with Run() as run:
# Specify a run name, metadata (dict), tags (list), description, folder
run.init(
"example-run-name",
{
"learning_rate": 0.001,
"training_steps": 2000,
"batch_size": 32,
}, # Metadaata
["tensorflow"], # Tags
"This is a test.", # Description
"/Project-A/part1",
) # Folder full path
# Set folder details if necessary
run.set_folder_details(
"/Project-A/part1", # Folder full path
metadata={}, # Metadata
tags=["tensorflow"], # Tags
description="This is part 1 of a test",
) # Description
# Upload the code
run.save_file("training.py", "code")
# Upload an input file
run.save_file("params.in", "input")
# Add an alert (the alert definition will be created if necessary)
run.create_metric_threshold_alert(
name="loss-too-high", # Name
rule="is above", # Rule
metric="loss", # Metric
frequency=1, # Frequency
window=1, # Window
threshold=10, # Threshold
notification="email", # Notification type
)
...
while not converged:
...
# Send metrics inside main application loop
run.log_metrics({"loss": 0.5, "density": 34.4})
...
# Upload an output file
run.save_file("output.cdf", "output")
# If we weren't using a context manager we'd need to end the run
# run.close()
License
Released under the terms of the Apache 2 license.
3 maintainers
Release files for simvue 2.6.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 | |
|---|---|---|---|
| simvue-2.6.0.tar.gz | 541.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| simvue-2.6.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 725.5 kB
Release files / simvue-2.6.0.tar.gz
| Download URL | simvue-2.6.0.tar.gz |
|---|---|
| Size | 541.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
229bc0691fc4519dd8c3bdad92efc36d0071c6994864f9b700293074bd7fc6ea
|
|
BLAKE2b-256 checksum How to use checksums |
487cecf9c00e8d7d022e8f21d7836a88083ae76d8fd903d37169d461057c046c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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 Sep 25, 2026.
Transparency logRelease files / simvue-2.6.0-py3-none-any.whl
| Download URL | simvue-2.6.0-py3-none-any.whl |
|---|---|
| Size | 184.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9551c456b933d6553cfdd94de1cca81dd59412f60abc070f53a5f9ef7902a82b
|
|
BLAKE2b-256 checksum How to use checksums |
25a84e2766e13c3fc2b6e385b7d52e90ceadf04420c94b0ad63d2d8375cc43dd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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 Sep 25, 2026.
Transparency log
