simframe


Namesimframe JSON
Version 1.0.5 PyPI version JSON
download
home_pageNone
SummaryFramework for Scientific Simulations
upload_time2024-06-30 13:24:53
maintainerNone
docs_urlNone
authorNone
requires_pythonNone
licenseBSD 3-Clause License Copyright (c) 2020-2023, Simframe developers All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
keywords numerical simulation integration science mathematics physics
VCS
bugtrack_url
requirements dill h5py matplotlib numpy scipy
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 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) <br /> &nbsp;
* [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) <br /> &nbsp;
* [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) <br /> &nbsp;
* [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).

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "simframe",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": "Sebastian Stammler <sebastian.stammler@gmail.com>, Tilman Birnstiel <til.birnstiel@lmu.de>",
    "keywords": "numerical, simulation, integration, science, mathematics, physics",
    "author": null,
    "author_email": "Sebastian Stammler <sebastian.stammler@gmail.com>, Til Birnstiel <til.birnstiel@lmu.de>",
    "download_url": "https://files.pythonhosted.org/packages/2a/d7/8af1b2b7fd138e6df6c3a03ba68b0cc681b60a8724c08218ef70d596010b/simframe-1.0.5.tar.gz",
    "platform": null,
    "description": "# Simframe\n\n[![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)  \n[![status](https://joss.theoj.org/papers/0ef61e034c57445e846b2ec383c920a6/status.svg)](https://joss.theoj.org/papers/0ef61e034c57445e846b2ec383c920a6)  \n[![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)\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) <br /> &nbsp;\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* [Example: N-body Problem](https://simframe.readthedocs.io/en/latest/example_nbody.html) <br /> &nbsp;\n* [A. Citation](https://simframe.readthedocs.io/en/latest/A_citation.html)\n* [B. Contributing/Bugs/Features](https://simframe.readthedocs.io/en/latest/B_contrib_bug_feature.html)\n* [C. Changelog](https://simframe.readthedocs.io/en/latest/C_changelog.html) <br /> &nbsp;\n* [Module Reference](https://simframe.readthedocs.io/en/latest/api.html)\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 3-Clause License  Copyright (c) 2020-2023, Simframe developers All rights reserved.  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.  3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.",
    "summary": "Framework for Scientific Simulations",
    "version": "1.0.5",
    "project_urls": {
        "Documentation": "https://simframe.readthedocs.io/",
        "Repository": "https://github.com/stammler/simframe/"
    },
    "split_keywords": [
        "numerical",
        " simulation",
        " integration",
        " science",
        " mathematics",
        " physics"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2ad78af1b2b7fd138e6df6c3a03ba68b0cc681b60a8724c08218ef70d596010b",
                "md5": "2a037173456d672ca49dd683dfad919d",
                "sha256": "2ae6e92a63f466ab1974be6a9d4c80ada66dcdc7340b183cc658a68de1985fb7"
            },
            "downloads": -1,
            "filename": "simframe-1.0.5.tar.gz",
            "has_sig": false,
            "md5_digest": "2a037173456d672ca49dd683dfad919d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 13941172,
            "upload_time": "2024-06-30T13:24:53",
            "upload_time_iso_8601": "2024-06-30T13:24:53.170820Z",
            "url": "https://files.pythonhosted.org/packages/2a/d7/8af1b2b7fd138e6df6c3a03ba68b0cc681b60a8724c08218ef70d596010b/simframe-1.0.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-06-30 13:24:53",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "stammler",
    "github_project": "simframe",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "dill",
            "specs": []
        },
        {
            "name": "h5py",
            "specs": []
        },
        {
            "name": "matplotlib",
            "specs": []
        },
        {
            "name": "numpy",
            "specs": []
        },
        {
            "name": "scipy",
            "specs": []
        }
    ],
    "lcname": "simframe"
}
        
Elapsed time: 1.45422s