simvue

Simvue Python API

https://github.com/simvue-io/python-api

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Academic email domains
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (13.5%) to scientific vocabulary

Keywords

alerting metrics metrics-gathering monitoring simvue tracking

Last synced: 6 months ago · JSON representation ·

Repository

Simvue Python API

Basic Info

Host: GitHub
Owner: simvue-io
License: apache-2.0
Language: Python
Default Branch: dev
Homepage: https://docs.simvue.io
Size: 21.3 MB

Statistics

Stars: 4
Watchers: 3
Forks: 0
Open Issues: 42
Releases: 50

Topics

alerting metrics metrics-gathering monitoring simvue tracking

Created over 3 years ago · Last pushed 6 months ago

Metadata Files

Readme Changelog Contributing License Code of conduct Citation

Simvue Python client

Simvue

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: sh export SIMVUE_URL=... export SIMVUE_TOKEN=... or a file simvue.toml can be created containing: toml [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

```python 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.

Owner

Name: simvue
Login: simvue-io
Kind: organization
Location: United Kingdom

Website: https://simvue.io
Repositories: 3
Profile: https://github.com/simvue-io

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: Simvue
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Andrew
    family-names: Lahiff
    affiliation: United Kingdom Atomic Energy Authority
    orcid: 'https://orcid.org/0000-0002-2785-4116'
  - given-names: Aby
    family-names: Abraham
    affiliation: United Kingdom Atomic Energy Authority
  - given-names: Vignesh
    family-names: Gopakumar
    orcid: 'https://orcid.org/0000-0002-6773-1049'
    affiliation: United Kingdom Atomic Energy Authority
  - given-names: Kristian
    family-names: Zarebski
    affiliation: United Kingdom Atomic Energy Authority
    orcid: 'https://orcid.org/0000-0002-6773-1049'
  - given-names: Matthew
    family-names: Field
    affiliation: United Kingdom Atomic Energy Authority
  - given-names: James
    family-names: Panayis
    affiliation: United Kingdom Atomic Energy Authority
repository-code: 'https://github.com/simvue-io/client'
url: 'https://simvue.io/'
abstract: >-
  Simvue allows users to organise and gain insights in simulations,
  processing tasks and AI/ML training by capturing metadata and
  data combined with real-time monitoring, logging and alerting.
keywords:
  - tracking
  - monitoring
  - metrics
  - alerting
  - simulation
license: Apache-2.0
commit: b334b61dba33a76acef1e9fa9df0f0d394beb4de
version: 2.1.2
date-released: '2025-06-25'

GitHub Events

Total

Create event: 169
Issues event: 187
Release event: 10
Watch event: 1
Delete event: 149
Issue comment event: 160
Push event: 541
Pull request review comment event: 62
Pull request review event: 69
Pull request event: 300

Last Year

Create event: 169
Issues event: 187
Release event: 10
Watch event: 1
Delete event: 149
Issue comment event: 160
Push event: 541
Pull request review comment event: 62
Pull request review event: 69
Pull request event: 300

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 140
Total pull requests: 232
Average time to close issues: 3 months
Average time to close pull requests: 10 days
Total issue authors: 8
Total pull request authors: 5
Average comments per issue: 0.94
Average comments per pull request: 0.13
Merged pull requests: 169
Bot issues: 3
Bot pull requests: 117

Past Year

Issues: 115
Pull requests: 199
Average time to close issues: 16 days
Average time to close pull requests: 2 days
Issue authors: 8
Pull request authors: 5
Average comments per issue: 0.91
Average comments per pull request: 0.11
Merged pull requests: 150
Bot issues: 3
Bot pull requests: 100

View more stats

Top Authors

Issue Authors

alahiff (49)
kzscisoft (39)
wk9874 (34)
AbyAbraham21 (6)
james-panayis (3)
timothy-nunn (3)
dependabot[bot] (3)
gitvicky (3)

Pull Request Authors

dependabot[bot] (75)
kzscisoft (68)
pre-commit-ci[bot] (42)
wk9874 (41)
alahiff (6)

Top Labels

Issue Labels

bug (37) ready for testing (30) enhancement (17) CI (5) question (5) dependencies (4) testing (3) v1.0.2 (3) improvement (3) backlog (3) blocking (3) good first issue (3) release (1) python (1) Windows (1) in progress (1) wontfix (1) documentation (1)

Pull Request Labels

dependencies (76) enhancement (26) bug (25) python (5) CI (4) improvement (2) testing (1) documentation (1)

Packages

Total packages: 1
Total downloads:
- pypi 533 last-month

Total dependent packages: 0
Total dependent repositories: 1
Total versions: 68
Total maintainers: 3

pypi.org: simvue

Simulation tracking and monitoring

Homepage: https://simvue.io
Documentation: https://docs.simvue.io
License: Apache v2
Latest release: 2.1.2
published 8 months ago

Versions: 68
Dependent Packages: 0
Dependent Repositories: 1
Downloads: 533 Last month

Rankings

Dependent packages count: 10.1%

Dependent repos count: 21.6%

Average: 22.7%

Downloads: 24.1%

Stargazers count: 27.9%

Forks count: 29.8%

Maintainers (3)

artemis-beta alahiff wk9874