sim-explorer Documentation

Contents:

• Introduction
  • Installation
  • Development Setup
    • 1. Install uv
    • 2. Install Python
    • 3. Clone the repository
    • 4. Install dependencies
    • 5. (Optional) Activate the virtual environment
    • 6. Install pre-commit hooks
    • 7. Test that the installation works
  • Meta
  • Contribute
• API Reference
  • sim-explorer package
    • Subpackages
      • sim_explorer.utils
    • Modules
      • sim_explorer.json5
      • sim_explorer.system_interface
      • sim_explorer.case
• CLI Documentation
  • sim-explorer - CLI interface
    • sim-explorer positional arguments
    • sim-explorer options
• File Format
  • Cases file
    • Header elements
    • Definition of case variables
    • Case specification
      • The mandatory case base:
      • Specification of results:
    • Variable specification
    • Simple example BouncingBall3D.cases
• Changelog
  • Unreleased
  • 0.2.1 - 2025-02-05
    • Added
    • Changed
    • Solved
    • Dependencies
  • 0.2.0 - 2024-12-18
  • 0.1.0 - 2024-11-08
    • Changed
    • GitHub workflows
    • Dependencies
  • 0.0.1 - 2023-02-21
    • Added
    • Changed
    • Dependencies
    • Fixed
    • Deprecated
    • Removed
• Style Guide
  • References
  • Code Layout
  • Line Breaks
  • String Formatting
  • Naming Conventions
  • Named Arguments
  • Commenting
  • Type hints
  • Docstrings
  • Exceptions
  • Imports
  • Unit-tests
  • And finally: It is a bad idea to use
• LICENSE

Indices and tables

• Index

• Module Index

• Search Page