simframe documentation

simframe is a framework to flexibly build scientific simulations.

It comes with a variety of integration schemes and some infrastructure for writing and reading data files.

To install simframe simply type

pip install simframe

Please have a look at the following examples to learn how to use simframe.

Contents:

• Simple Integration
  • Setting up frames
  • Creating fields
  • Setting up derivatives
  • Creating integration variables
  • Setting up the integrator
  • Setting up writers
  • Running simulations
  • Reading data
  • Reading dump files
  • Progress bar
• Advanced Integration
  • Creating groups
  • Creating immutable fields
  • Displaying the table of contents
  • Setting up complex integration instructions
  • Leapfrog integration
• Updating Groups and Fields
  • Skipping Fields in Output Files
  • Updating fields
  • Updating groups
  • The heartbeat concept
• Custom Integration Schemes
  • Writing custom integration schemes
  • Available integration schemes
• Adaptive Integration Schemes
  • Adaptive Step Sizing Schemes
  • The fail operation
  • Preparation and finalization
  • Suggested step sizes
  • Passing keyword arguments to integration scheme
• Implicit Integration
  • Background: Implicit integration
  • Setting up implicit integration
• Coupled Oscillators
• Module Reference
  • simframe.frame Package
  • simframe.integration Package
  • simframe.integration.schemes Package
  • simframe.io Package
  • simframe.io.writers Package
  • simframe.utils Package

Indices and tables

• Index

• Module Index

• Search Page