# Simframe
[](https://simframe.readthedocs.io/en/latest/?badge=latest) [ ](https://github.com/stammler/simframe/blob/master/LICENSE) [](https://github.com/stammler/simframe/blob/master/.github/CODE_OF_CONDUCT.md)
[](https://joss.theoj.org/papers/0ef61e034c57445e846b2ec383c920a6)
[](https://pypistats.org/packages/simframe) [](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).
Raw data
{
"_id": null,
"home_page": "https://github.com/stammler/simframe",
"name": "simframe",
"maintainer": "Sebastian Stammler",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "numerical,simulation,integration,science,mathematics,physics",
"author": "Sebastian Stammler, Tilman Birnstiel",
"author_email": "sebastian.stammler@gmail.com, til.birnstiel@lmu.de",
"download_url": "https://files.pythonhosted.org/packages/6d/aa/2e29746f821b26b5ae1c100443924c800459e8c21160184a48a26c9aa163/simframe-1.0.4.tar.gz",
"platform": null,
"description": "# Simframe\n\n[](https://simframe.readthedocs.io/en/latest/?badge=latest) [ ](https://github.com/stammler/simframe/blob/master/LICENSE) [](https://github.com/stammler/simframe/blob/master/.github/CODE_OF_CONDUCT.md) \n[](https://joss.theoj.org/papers/0ef61e034c57445e846b2ec383c920a6) \n[](https://pypistats.org/packages/simframe) [](https://src.fedoraproject.org/rpms/python-simframe)\n\n### Framework for scientific simulations\n\n`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.\n\nData fields are stored in modified `numpy.ndarray`s. Therefore, `Simframe` can only work with data, that can be stored in `NumPy` arrays.\n\n## Installation\n\n`pip install simframe`\n\n## Documentation\n\n[https://simframe.readthedocs.io/](https://simframe.readthedocs.io/)\n\n* [1. Simple Integration](https://simframe.readthedocs.io/en/latest/1_simple_integration.html)\n* [2. Advanced Integration](https://simframe.readthedocs.io/en/latest/2_advanced_integration.html)\n* [3. Updating Groups and Fields](https://simframe.readthedocs.io/en/latest/3_updating.html)\n* [4. Custom Integration Schemes](https://simframe.readthedocs.io/en/latest/4_custom_schemes.html)\n* [5. Adaptive Integration Schemes](https://simframe.readthedocs.io/en/latest/5_adaptive_schemes.html)\n* [6. Implicit Integration](https://simframe.readthedocs.io/en/latest/6_implicit_integration.html)\n* [Example: Coupled Oscillators](https://simframe.readthedocs.io/en/latest/example_coupled_oscillators.html)\n* [Example: Double Pendulum](https://simframe.readthedocs.io/en/latest/example_double_pendulum.html)\n* [Example: Compartmental Models](https://simframe.readthedocs.io/en/latest/example_compartmental_models.html)\n\n[Module Reference](https://simframe.readthedocs.io/en/latest/api.html)\n\n## Contributing\n\nTo contribute to the software, please read the [contribution guidelines](https://github.com/stammler/simframe/blob/master/.github/CONTRIBUTING.md).\n\n## Citation\n\nIf you use `Simframe`, please remember to cite [Stammler & Birnstiel (2022)](https://doi.org/10.21105/joss.03882).\n\n```\n@article{simframe,\n doi = {10.21105/joss.03882},\n url = {https://doi.org/10.21105/joss.03882},\n year = {2022},\n publisher = {The Open Journal},\n volume = {7},\n number = {69},\n pages = {3882},\n author = {Sebastian M. Stammler and Tilman Birnstiel},\n title = {Simframe: A Python Framework for Scientific Simulations},\n journal = {Journal of Open Source Software}\n}\n\n```\n\n## Ackowledgements\n\n`simframe` has received funding from the European Research Council (ERC) under the European Union\u2019s Horizon 2020 research and innovation programme under grant agreement No 714769.\n\n`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).\n",
"bugtrack_url": null,
"license": "BSD",
"summary": "Framework for Scientific Simulations",
"version": "1.0.4",
"project_urls": {
"Documentation": "https://simframe.readthedocs.io/",
"Homepage": "https://github.com/stammler/simframe",
"Source Code": "https://github.com/stammler/simframe/"
},
"split_keywords": [
"numerical",
"simulation",
"integration",
"science",
"mathematics",
"physics"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "287f30af4d8a9de568321d65ce9d8f66e32087584bda74aeb6e7ed4334ffebb4",
"md5": "df2e3cddd6876aa1841b713919ec0cd3",
"sha256": "95bd0ca11e379d8f84788686d0f41f3229694df4d28c9f558cfc1772f5fc1fa2"
},
"downloads": -1,
"filename": "simframe-1.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "df2e3cddd6876aa1841b713919ec0cd3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 59412,
"upload_time": "2023-07-21T15:05:46",
"upload_time_iso_8601": "2023-07-21T15:05:46.494911Z",
"url": "https://files.pythonhosted.org/packages/28/7f/30af4d8a9de568321d65ce9d8f66e32087584bda74aeb6e7ed4334ffebb4/simframe-1.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6daa2e29746f821b26b5ae1c100443924c800459e8c21160184a48a26c9aa163",
"md5": "642624b2fa036367bc77e4a44b155973",
"sha256": "9f20e7a7d0ebc21e6a0fec8d6a5e14aa9e77d4fbb14a64236a4de8394890ff00"
},
"downloads": -1,
"filename": "simframe-1.0.4.tar.gz",
"has_sig": false,
"md5_digest": "642624b2fa036367bc77e4a44b155973",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4353626,
"upload_time": "2023-07-21T15:05:50",
"upload_time_iso_8601": "2023-07-21T15:05:50.773471Z",
"url": "https://files.pythonhosted.org/packages/6d/aa/2e29746f821b26b5ae1c100443924c800459e8c21160184a48a26c9aa163/simframe-1.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-21 15:05:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "stammler",
"github_project": "simframe",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "simframe"
}
JSON
