Welcome to Carousel’s documentation!¶
Version: 0.2.7 (Brown Bicycle Bears)
There are some important changes for this version that may break some Carousel models.
Carousel now recommends using class attributes instead of JSON parameter files to declare outputs, data, formulas, calculations, simulations and models. Parameter files can still be used and there are currently no plans to deprecate them.
The use of a simulation filename and path has been deprecated. If you use a
simulation filename and path in your model and you have enabled logging you
should see a
exceptions.DeprecationWarning. The preferred style is to
set simulation parameters in your simulation class as class attributes.
For more information on these changes and the simulation layer please see the Models and Simulations tutorial.
- Getting Started
- Tutorial 1: Outputs
- Tutorial 2: Calculations
- Tutorial 3: Formulas
- Tutorial 3: More Detail on Units and Uncertainty
- Tutorial 4: Data
- Tutorial 5: Models and Simulations
- Data Sources
- Data Readers
Carousel - Model Simulation Framework¶
Carousel ia a framework for simulating mathematical models that decouples the models from the simulation implementation. It takes care of boilerplate routines such as loading data from various sources into a key store that can be used from any calculation, determining the correct order of calculations, stepping through dynamic simulations and generating output reports and visualizations, so that you can focus on developing models and don’t have to worry about how to add new models or how to integrate changes.
- Built in integration of units and uncertainty.
- Built in management of input data, calculated outputs and formulas in simple key store.
- Boilerplate designs for reading data from various sources.
- Automatic determination of calculation order.
- Boilerplate designs for progress display and output reports.
- All configuration files use human readable JSON serialization.
$ pip install Carousel
Extract the archive to use disutils
$ python setup.py install
Carousel documentation is
online. It’s also included in the distribution and can be built by running the
Makefile found in the
docs folder of the Carousel package.
Documentation uses Sphinx, and built documentation will be found in the
_build folder under the tree corresponding to the type of documentation
built. EG: HTML documentation is in