saidctb / 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.

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

Installation

pip install simframe

Documentation

https://simframe.readthedocs.io/

• 1. Simple Integration
• 2. Advanced Integration
• 3. Updating Groups and Fields
• 4. Custom Integration Schemes
• 5. Adaptive Integration Schemes
• 6. Implicit Integration
• Example: Coupled Oscillators
• Example: Double Pendulum
• Example: Compartmental Models

Module Reference

Contributing

To contribute to the software, please read the contribution guidelines.

Citation

If you use Simframe, please remember to cite Stammler & Birnstiel (2022).

@article{simframe,
  doi = {10.21105/joss.03882},
  url = {https://doi.org/10.21105/joss.03882},
  year = {2022},
  publisher = {The Open Journal},
  volume = {7},
  number = {69},
  pages = {3882},
  author = {Sebastian M. Stammler and Tilman Birnstiel},
  title = {Simframe: A Python Framework for Scientific Simulations},
  journal = {Journal of Open Source Software}
}

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 of the Ludwig Maximilian University of Munich.