SimProv

SimProv is a practical solution for capturing provenance information of simulation studies. The software ensures a clear separation of concerns between provenance capturers, responsible for gathering information from various software systems used in the modeling process, and a provenance builder, which extracts and organizes this information into a provenance graph.

Features

• Automated Provenance Capture: Simprov automates the collection of provenance information by integrating with various software systems commonly used in simulation studies.

• Provenance Graph Generation: Using a client-server architecture, Simprov constructs a provenance graph that visually represents the relationships between entities, activities, and contributors involved in the simulation study.

• Rule-Based Processing: The software employs rule-based processing to extract relevant information from collected data and generate a comprehensive provenance graph.

• Web Interface: Simprov provides a user-friendly web interface for exploring the captured provenance graph, enabling researchers to visualize and analyze the history of their simulation studies.

• Integration Support: Simprov supports integration with existing simulation tools and workflows, making it easy to incorporate automated provenance capture into research practices.

Contribute

• Source Code: https://github.com/MosiSimProv/SimProv

• Issue Tracker: https://github.com/MosiSimProv/SimProv/issues

• Documentation: https://simprov.readthedocs.io/en/latest/

Support

If you are having issues, please let me know. You can write me a mail: andreas.ruscheinski@uni-rostock.de

Table of Contents

• SimProv
• Quickstart
  • Dependencies
  • Usage
• Installation
  • Getting the Source
  • Python Version
  • Method 1 - Manual Installation
  • Method 2 - Build a Docker Image
  • Method 3 - Download Pre-build Docker Image
• User Guide
  • Using SimProv
  • Building a Provenance Capturer
  • Specifying Provenance Patterns
  • Specifying Rules
  • Extracting Provenance Information from an Event
• Extensions
  • SimProvWeb
  • VSCode Plugin
  • SimProv Helper Library
• Developer Guide
  • Developer Interface
  • REST-API

License

MIT License

Copyright (c) 2025, Andreas Ruscheinski

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.