simframe Documentation

simframe is a Python framework to facilitate scientific simulations. The scope of the software is to provide a framework which can hold data fields, which can be used to integrate differential equations, and which can read and write data files.

Data fields are stored in modified numpy.ndarrays. Therefore, simframe can only work with data, that can be stored in NumPy arrays.

To install simframe simply type

pip install simframe

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

Contents:

• 1. 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
• 2. Advanced Integration
  • Creating groups
  • Creating immutable fields
  • Displaying the table of contents
  • Inspecting memory usage
  • Setting up complex integration instructions
  • Leapfrog integration
• 3. Updating Groups and Fields
  • Skipping Fields in Output Files
  • Updating fields
  • Updating groups
  • The heartbeat concept
• 4. Custom Integration Schemes
  • Writing custom integration schemes
  • Available integration schemes
• 5. Adaptive Integration Schemes
  • Adaptive Step Sizing Schemes
  • The fail operation
  • Preparation and finalization
  • Suggested step sizes
  • Passing keyword arguments to integration scheme
• 6. Implicit Integration
  • Background: Implicit integration
  • Setting up implicit integration
• Example: Coupled Oscillators
• Example: Double Pendulum
• Example: Compartmental Models
  • SIRD Model
  • SECIR Model
• Appendix A: Citation
• Appendix B: Contributing/Bugs/Features
  • Contributing to simframe
  • Bug Report
  • Feature Request
• 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