Metadata-Version: 2.1
Name: simframe
Version: 1.0.4
Summary: Framework for Scientific Simulations
Home-page: https://github.com/stammler/simframe
Author: Sebastian Stammler, Tilman Birnstiel
Author-email: sebastian.stammler@gmail.com, til.birnstiel@lmu.de
Maintainer: Sebastian Stammler
License: BSD
Project-URL: Source Code, https://github.com/stammler/simframe/
Project-URL: Documentation, https://simframe.readthedocs.io/
Keywords: numerical,simulation,integration,science,mathematics,physics
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Education
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Topic :: Scientific/Engineering :: Physics
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: dill
Requires-Dist: h5py
Requires-Dist: matplotlib
Requires-Dist: numpy
Requires-Dist: scipy

# Simframe

[![Documentation Status](https://readthedocs.org/projects/simframe/badge/?version=latest)](https://simframe.readthedocs.io/en/latest/?badge=latest) [![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)  
[![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)
* [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)

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

## Contributing

To contribute to the software, please read the [contribution guidelines](https://github.com/stammler/simframe/blob/master/.github/CONTRIBUTING.md).

## Citation

If you use `Simframe`, please remember to cite [Stammler & Birnstiel (2022)](https://doi.org/10.21105/joss.03882).

```
@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](https://www.usm.uni-muenchen.de/index_en.php) of the [Ludwig Maximilian University of Munich](https://www.en.uni-muenchen.de/index.html).
