Home

collimator is the Python package for Collimator's Python- and cloud-native simulation platform. It contains both a local high-performance simulation engine and a client API to run simulations in the cloud.

Installation

Install collimator in your Python environment with: pip install pycollimator.

More details in the installation guide.

Tutorials

Not sure what to do first? Check out our tutorials beginning with Getting started.

Examples

More advanced examples can be found in examples.

API Reference

The core documentation, grouped as follows:

Framework

Base classes and functions for building models

Block library

Core blocks that you can use to build larger models

Simulation

Classes and functions for running simulations

Optimization

The Trainer class and associated functions for optimizing your models

API

Functions for interacting with Collimator cloud application.