https://github.com/stammler/simframe

Python framework for setting up and running scientific simulations. It comes with a variety of integration schemes and some infrastructure of reading and writing data files.
https://github.com/stammler/simframe

differential-equations python science simulation

Last synced: 3 months ago
JSON representation

Python framework for setting up and running scientific simulations. It comes with a variety of integration schemes and some infrastructure of reading and writing data files.

• Host: GitHub
• URL: https://github.com/stammler/simframe
• Owner: stammler
• License: bsd-3-clause
• Created: 2020-07-29T12:18:55.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2025-09-03T15:46:06.000Z (5 months ago)
• Last Synced: 2025-10-16T21:12:31.144Z (3 months ago)
• Topics: differential-equations, python, science, simulation
• Language: Python
• Homepage: https://simframe.readthedocs.io/
• Size: 28.8 MB
• Stars: 12
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# Simframe

[![GitHub](https://img.shields.io/github/license/stammler/simframe) ](https://github.com/stammler/simframe/blob/master/LICENSE) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](https://github.com/stammler/simframe/blob/master/.github/CODE_OF_CONDUCT.md)  

[![Documentation Status](https://readthedocs.org/projects/simframe/badge/?version=latest)](https://simframe.readthedocs.io/en/latest/?badge=latest) ![Unit Tests](https://github.com/stammler/simframe/actions/workflows/unit_tests.yml/badge.svg)  

[![status](https://joss.theoj.org/papers/0ef61e034c57445e846b2ec383c920a6/status.svg)](https://joss.theoj.org/papers/0ef61e034c57445e846b2ec383c920a6)  

[![PyPI - Downloads](https://img.shields.io/pypi/dm/simframe?label=PyPI%20downloads)](https://pypistats.org/packages/simframe) [![Fedora package](https://img.shields.io/fedora/v/python3-simframe?color=blue&label=Fedora%20Linux&logo=fedora)](https://src.fedoraproject.org/rpms/python-simframe)

### Framework for scientific simulations

`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.ndarray`s. Therefore, `Simframe` can only work with data, that can be stored in `NumPy` arrays.

## Installation

`pip install simframe`

## Documentation

[https://simframe.readthedocs.io/](https://simframe.readthedocs.io/)

* [1. Simple Integration](https://simframe.readthedocs.io/en/latest/1_simple_integration.html)

* [2. Advanced Integration](https://simframe.readthedocs.io/en/latest/2_advanced_integration.html)

* [3. Updating Groups and Fields](https://simframe.readthedocs.io/en/latest/3_updating.html)

* [4. Custom Integration Schemes](https://simframe.readthedocs.io/en/latest/4_custom_schemes.html)

* [5. Adaptive Integration Schemes](https://simframe.readthedocs.io/en/latest/5_adaptive_schemes.html)

* [6. Implicit Integration](https://simframe.readthedocs.io/en/latest/6_implicit_integration.html)

* [7. Signal Handling](https://simframe.readthedocs.io/en/latest/7_signal_handling.html) 
  

* [Example: Coupled Oscillators](https://simframe.readthedocs.io/en/latest/example_coupled_oscillators.html)

* [Example: Double Pendulum](https://simframe.readthedocs.io/en/latest/example_double_pendulum.html)

* [Example: Compartmental Models](https://simframe.readthedocs.io/en/latest/example_compartmental_models.html)

* [Example: N-body Problem](https://simframe.readthedocs.io/en/latest/example_nbody.html) 
  

* [A. Citation](https://simframe.readthedocs.io/en/latest/A_citation.html)

* [B. Contributing/Bugs/Features](https://simframe.readthedocs.io/en/latest/B_contrib_bug_feature.html)

* [C. Changelog](https://simframe.readthedocs.io/en/latest/C_changelog.html) 
  

* [Module Reference](https://simframe.readthedocs.io/en/latest/api.html)

## Ackowledgements

`simframe` has received funding from the European Research Council (ERC) under the European Union’s Horizon 2020 research and innovation programme under grant agreement No 714769.

`simframe` was developed at the [University Observatory](https://www.usm.uni-muenchen.de/index_en.php) of the [Ludwig Maximilian University of Munich](https://www.en.uni-muenchen.de/index.html).