Sim2l

Getting Started

  • Project Overview
  • Installation
    • Stable release
    • From sources
  • Quick Start Guide
    • Installation
    • Basic Usage
      • Minimal Example
      • With Run Database
      • With Services
    • Docker Quick Start
    • Common Workflows
      • Workflow 1: Simple Simulation
      • Workflow 2: With Caching
      • Workflow 3: File Management
      • Workflow 4: Result Search
    • Next Steps
    • Configuration Options
      • Environment Variables
      • Config File
      • Programmatic
    • Troubleshooting
      • Import Errors
      • Service Connection Errors
      • Run Database Not Found
    • Getting Help

User Guide

  • Usage
    • Quickstart
      • Setting Inputs
      • Running the Simtool
      • Visualizing the Outputs
      • Extras
  • Database Services
    • Overview
    • Quick Start
    • Run Database
      • Features
      • Usage
      • Context Manager
      • Database Location
      • API Reference
    • Cache Service
      • Features
      • Starting the Service
      • Using the Client
      • API Endpoints
      • API Reference
    • Catalog Service
      • Features
      • Starting the Service
      • Using the Client
      • Auto-Sync
      • API Reference
    • Results Service
      • Features
      • Starting the Service
      • Using the Client
      • What Gets Introspected
      • API Reference
    • File Manager
      • Features
      • Usage
      • Organizing Files
      • API Reference
    • Session Management
      • Features
      • Usage
      • Roles and Privileges
      • API Reference
    • Deployment
      • Local Development
      • Docker Deployment
      • Hybrid Deployment
      • Environment Variables
    • Performance
      • Benchmarks
      • Best Practices
    • Troubleshooting
      • Service Won’t Start
      • Can’t Connect to Service
      • Run Database Not Found
    • See Also
  • File Management
    • Overview
    • Basic Usage
      • Get Files from a Run
      • Export Files
      • Batch Export
      • Get Files for a Simulation
    • File Organization
      • Creating Folders
      • Creating Files
      • Listing Folder Contents
      • Moving Files
      • Deleting Files
    • Common Workflows
      • Workflow 1: Export Simulation Results
      • Workflow 2: Filter by File Type
      • Workflow 3: Organize by Simulation
      • Workflow 4: Compare Results
    • Advanced Features
      • File Metadata
      • Context Manager
      • Integration with Services
    • Best Practices
    • API Reference
      • FileManager Class
      • Key Methods
    • See Also
  • Examples
    • Basic Simulation
    • With Run Database
    • With Caching
    • File Export
    • Result Search
    • Complete Example
    • More Examples

Services

  • Cache Service
    • Overview
    • Quick Start
      • Starting the Service
      • Using the Client
    • REST API
      • GET /cache/{cache_key}
      • POST /cache
      • POST /cache/invalidate
      • GET /cache/stats
      • GET /health
    • Configuration
      • Command Line
      • Environment Variables
      • Docker
    • API Reference
  • Catalog Service
    • Quick Start
    • REST API
    • API Reference
  • Results Service
    • Quick Start
    • What Gets Introspected
    • REST API
    • API Reference

API Reference

  • Reference
  • Database API
    • sim2l.database
    • RunDatabase
    • CacheClient
    • CatalogClient
    • ResultsClient
    • FileManager
    • SessionManager
    • Functions
      • get_session_manager
  • Services API
    • sim2l.services
    • cache_service
      • adapt_postgres_schema_for_sqlite()
      • CacheServiceBackend
        • CacheServiceBackend.get()
        • CacheServiceBackend.set()
        • CacheServiceBackend.invalidate()
        • CacheServiceBackend.delete()
        • CacheServiceBackend.get_stats()
        • CacheServiceBackend.health_check()
      • SQLiteCacheBackend
        • SQLiteCacheBackend.__init__()
        • SQLiteCacheBackend.get()
        • SQLiteCacheBackend.set()
        • SQLiteCacheBackend.invalidate()
        • SQLiteCacheBackend.delete()
        • SQLiteCacheBackend.get_stats()
        • SQLiteCacheBackend.health_check()
        • SQLiteCacheBackend.list_entries()
      • PostgreSQLCacheBackend
        • PostgreSQLCacheBackend.__init__()
        • PostgreSQLCacheBackend.get()
        • PostgreSQLCacheBackend.set()
        • PostgreSQLCacheBackend.invalidate()
        • PostgreSQLCacheBackend.delete()
        • PostgreSQLCacheBackend.get_stats()
        • PostgreSQLCacheBackend.health_check()
        • PostgreSQLCacheBackend.list_entries()
      • health()
      • get_cache()
      • delete_cache()
      • set_cache()
      • invalidate_cache()
      • get_stats()
      • list_cache_entries()
      • main()
    • catalog_service
      • CatalogServiceBackend
        • CatalogServiceBackend.search()
        • CatalogServiceBackend.get_simulation()
        • CatalogServiceBackend.register_simulation()
        • CatalogServiceBackend.update_simulation()
        • CatalogServiceBackend.delete_simulation()
        • CatalogServiceBackend.record_execution()
        • CatalogServiceBackend.get_stats()
        • CatalogServiceBackend.sync_pending_requests()
        • CatalogServiceBackend.approve_sync()
        • CatalogServiceBackend.get_overview_stats()
        • CatalogServiceBackend.health_check()
      • SQLiteCatalogBackend
        • SQLiteCatalogBackend.__init__()
        • SQLiteCatalogBackend.search()
        • SQLiteCatalogBackend.get_simulation()
        • SQLiteCatalogBackend.register_simulation()
        • SQLiteCatalogBackend.update_simulation()
        • SQLiteCatalogBackend.delete_simulation()
        • SQLiteCatalogBackend.record_execution()
        • SQLiteCatalogBackend.get_stats()
        • SQLiteCatalogBackend.sync_pending_requests()
        • SQLiteCatalogBackend.approve_sync()
        • SQLiteCatalogBackend.get_overview_stats()
        • SQLiteCatalogBackend.health_check()
      • PostgreSQLCatalogBackend
        • PostgreSQLCatalogBackend.__init__()
        • PostgreSQLCatalogBackend.search()
        • PostgreSQLCatalogBackend.get_simulation()
        • PostgreSQLCatalogBackend.register_simulation()
        • PostgreSQLCatalogBackend.update_simulation()
        • PostgreSQLCatalogBackend.delete_simulation()
        • PostgreSQLCatalogBackend.record_execution()
        • PostgreSQLCatalogBackend.get_stats()
        • PostgreSQLCatalogBackend.sync_pending_requests()
        • PostgreSQLCatalogBackend.approve_sync()
        • PostgreSQLCatalogBackend.get_overview_stats()
        • PostgreSQLCatalogBackend.health_check()
      • health()
      • search_simulations()
      • get_simulation()
      • register_simulation()
      • update_simulation()
      • delete_simulation()
      • record_execution()
      • run_simulation()
      • get_stats()
      • get_pending_sync()
      • approve_sync()
      • get_overview_stats()
      • main()
    • results_service
  • Core API
    • sim2l
      • Field
        • Field.__init__()
        • Field.value
        • Field.type_name
        • Field.validate()
        • Field.serialize()
        • Field.deserialize()
        • Field.to_dict()
        • Field.from_dict()
      • Schema
        • Schema.__init__()
        • Schema.__getattr__()
        • Schema.__setattr__()
        • Schema.__getitem__()
        • Schema.__contains__()
        • Schema.__iter__()
        • Schema.items()
        • Schema.keys()
        • Schema.values()
        • Schema.validate()
        • Schema.set_values()
        • Schema.get_values()
        • Schema.serialize()
        • Schema.deserialize()
        • Schema.to_dict()
        • Schema.from_yaml()
        • Schema.from_dict()
      • InputSchema
      • OutputSchema
      • Integer
        • Integer.__init__()
        • Integer.validate()
        • Integer.serialize()
        • Integer.deserialize()
        • Integer.from_dict()
        • Integer.to_dict()
      • Number
        • Number.__init__()
        • Number.validate()
        • Number.serialize()
        • Number.deserialize()
        • Number.from_dict()
        • Number.to_dict()
      • Text
        • Text.__init__()
        • Text.validate()
        • Text.serialize()
        • Text.deserialize()
        • Text.from_dict()
        • Text.to_dict()
      • Array
        • Array.__init__()
        • Array.validate()
        • Array.serialize()
        • Array.deserialize()
        • Array.from_dict()
        • Array.to_dict()
      • Image
        • Image.validate()
        • Image.serialize()
        • Image.deserialize()
        • Image.from_dict()
      • Element
        • Element.__init__()
        • Element.validate()
        • Element.serialize()
        • Element.deserialize()
        • Element.from_dict()
        • Element.to_dict()
      • List
        • List.__init__()
        • List.validate()
        • List.serialize()
        • List.deserialize()
        • List.from_dict()
        • List.to_dict()
      • Dict
        • Dict.__init__()
        • Dict.validate()
        • Dict.serialize()
        • Dict.deserialize()
        • Dict.from_dict()
        • Dict.to_dict()
      • Boolean
        • Boolean.validate()
        • Boolean.serialize()
        • Boolean.deserialize()
        • Boolean.from_dict()
      • register_field_type()
      • get_field_class()
      • SimulationDefinition
        • SimulationDefinition.__init__()
        • SimulationDefinition.name
        • SimulationDefinition.version
        • SimulationDefinition.description
        • SimulationDefinition.author
        • SimulationDefinition.tags
        • SimulationDefinition.dependencies
        • SimulationDefinition.get_workflow_bytes()
        • SimulationDefinition.from_notebook()
        • SimulationDefinition.from_function()
        • SimulationDefinition.run()
      • SimulationMetadata
        • SimulationMetadata.__init__()
        • SimulationMetadata.to_dict()
        • SimulationMetadata.from_dict()
      • SimulationRepository
        • SimulationRepository.__init__()
        • SimulationRepository.deploy()
        • SimulationRepository.load()
        • SimulationRepository.list()
        • SimulationRepository.exists()
        • SimulationRepository.delete()
        • SimulationRepository.deprecate()
        • SimulationRepository.get_simulation_id()
        • SimulationRepository.create()
      • load_simulation()
      • list_simulations()
      • configure()
      • get_config()
      • deploy_simulation()
      • get_inputs()
      • save_outputs()
      • compute_squid_id()
      • get_squid_id_for_parameters()
      • Executor
        • Executor.__init__()
        • Executor.execute()
        • Executor.check_cache()
        • Executor.prepare_inputs()
      • LocalExecutor
        • LocalExecutor.__init__()
        • LocalExecutor.check_cache()
        • LocalExecutor.execute()
      • NotebookExecutor
        • NotebookExecutor.__init__()
        • NotebookExecutor.check_cache()
        • NotebookExecutor.execute()
      • ExecutionResult
        • ExecutionResult.__init__()
        • ExecutionResult.save()
        • ExecutionResult.load()
        • ExecutionResult.create()
        • ExecutionResult.set_outputs()
        • ExecutionResult.set_error()
      • load_result()
    • Configuration
      • configure()
    • Loading Simulations
      • load_simulation()

Additional Information

  • Deployment Guide
    • Architecture
    • Local Deployment
    • Docker Deployment
      • Setup
      • Environment
    • Hybrid Deployment
    • Production Checklist
      • Infrastructure
      • Security
      • Performance
      • Monitoring
    • Scaling
      • Horizontal Scaling
      • Load Balancing
    • Maintenance
      • Backups
      • Updates
      • Troubleshooting
  • Contributing
    • Types of Contributions
      • Report Bugs
      • Fix Bugs
      • Implement Features
      • Write Documentation
      • Submit Feedback
    • Get Started!
    • Pull Request Guidelines
    • Tips
  • Changelog
Sim2l
  • Usage
  • View page source

Usage

Contents:

  • Quickstart
    • Setting Inputs
    • Running the Simtool
    • Visualizing the Outputs
    • Extras
Previous Next

© Copyright 2024, Sim2l Contributors.

Built with Sphinx using a theme provided by Read the Docs.