| Name | splinebox JSON |
| Version |
0.3.0
JSON |
| download |
| home_page | None |
| Summary | A python package for fitting splines. |
| upload_time | 2025-01-08 09:18:36 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | BSD 3-Clause License Copyright (c) 2024, EPFL Center for Imaging 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 |
splines
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<img style="float: right;" src="https://imaging.epfl.ch/resources/logo-for-gitlab.svg">
# splinebox
A python package for fitting splines.
Developed by the [EPFL Center for Imaging](https://imaging.epfl.ch/) as part of a collaboration with the [Uhlmann Group at EMBL-EBI](https://www.ebi.ac.uk/research/uhlmann/) in Feb 2024.
[](https://splinebox.readthedocs.io/en/latest/?badge=latest)
[](https://github.com/EPFL-Center-for-Imaging/splinebox/raw/main/LICENSE)
[](https://pypi.org/project/splinebox)
[](https://python.org)
[](https://github.com/EPFL-Center-for-Imaging/splinebox/actions)
[](https://codecov.io/gh/EPFL-Center-for-Imaging/splinebox)
[](https://zenodo.org/doi/10.5281/zenodo.13358354)
## Features
* Flexible spline fitting for various applications.
* Support for many spline types in any dimesnionality.
* High-perfomance implementation in Python
* Extensive [documentation](https://splinebox.readthedocs.io/en/latest/?badge=latest) with [examples](https://splinebox.readthedocs.io/en/latest/auto_examples/index.html)
## Installation
You can install `splinebox` via pip:
```
pip install splinebox
```
## Usage
Here is a minimal example of a cubic B-spline in 2D with 3 knots.
```python
import splinebox
import numpy as np
import matplotlib.pyplot as plt
n_knots = 4
spline = splinebox.spline_curves.Spline(M=n_knots, basis_function=splinebox.basis_functions.B3(), closed=True)
spline.knots = np.array([[1, 2], [3, 2], [4, 3], [1, 1]])
t = np.linspace(0, n_knots, 100)
vals = spline.eval(t, derivative=0)
plt.scatter(spline.knots[:, 0], spline.knots[:, 1])
plt.plot(vals[:, 0], vals[:, 1])
plt.show()
```
## Support
If you encounter any problems, please [file and issue](https://github.com/EPFL-Center-for-Imaging/splinebox/issues/new) describing the issue and include minimal example to reproduce the issue.
## Contributing
We welcome contributions! Before you submit a pull request, please ensure that the tests are passing. You can run the tests with [pytest](https://docs.pytest.org/en/stable/). If you are unsure how to implement something, feel free to open an issue to discuss.
## Citing splinebox
If you use splinebox in the context of scientific publication, please cite it as follows.
Note, that you will have to fill in the version yourself. If you are unsure what version you are running,
you can find out by running
```python
import splinebox
print(splinbox.__version__)`
```
BibTeX:
```
@misc{splinebox,
author = {Aymanns, Florian and Andò, Edward and Uhlmann, Virginie},
title = {{S}pline{B}ox},
url = {https://pypi.org/project/splinebox/},
doi = {10.5281/zenodo.13358354},
note = {{V}ersion V.V.Vb1},
year = 2024,
}
```
## License
This is an open source project licensed under the BSD-3-Clause License.
Raw data
{
"_id": null,
"home_page": null,
"name": "splinebox",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "Florian Aymanns <flroian.aymanns@epfl.ch>",
"keywords": "splines",
"author": null,
"author_email": "Florian Aymanns <florian.aymanns@epfl.ch>, Virginie Uhlmann <uhlmann@ebi.ac.uk>, Edward And\u00f2 <edward.ando@epfl.ch>",
"download_url": "https://files.pythonhosted.org/packages/48/40/5c1812a3e7c0423a0066d405258da75ec376e5538c96c54cff192042f072/splinebox-0.3.0.tar.gz",
"platform": null,
"description": "<img style=\"float: right;\" src=\"https://imaging.epfl.ch/resources/logo-for-gitlab.svg\">\n\n# splinebox\nA python package for fitting splines.\nDeveloped by the [EPFL Center for Imaging](https://imaging.epfl.ch/) as part of a collaboration with the [Uhlmann Group at EMBL-EBI](https://www.ebi.ac.uk/research/uhlmann/) in Feb 2024.\n\n[](https://splinebox.readthedocs.io/en/latest/?badge=latest)\n[](https://github.com/EPFL-Center-for-Imaging/splinebox/raw/main/LICENSE)\n[](https://pypi.org/project/splinebox)\n[](https://python.org)\n[](https://github.com/EPFL-Center-for-Imaging/splinebox/actions)\n[](https://codecov.io/gh/EPFL-Center-for-Imaging/splinebox)\n[](https://zenodo.org/doi/10.5281/zenodo.13358354)\n\n## Features\n* Flexible spline fitting for various applications.\n* Support for many spline types in any dimesnionality.\n* High-perfomance implementation in Python\n* Extensive [documentation](https://splinebox.readthedocs.io/en/latest/?badge=latest) with [examples](https://splinebox.readthedocs.io/en/latest/auto_examples/index.html)\n\n## Installation\n\nYou can install `splinebox` via pip:\n```\npip install splinebox\n```\n\n## Usage\n\nHere is a minimal example of a cubic B-spline in 2D with 3 knots.\n\n```python\nimport splinebox\nimport numpy as np\nimport matplotlib.pyplot as plt\n\nn_knots = 4\nspline = splinebox.spline_curves.Spline(M=n_knots, basis_function=splinebox.basis_functions.B3(), closed=True)\nspline.knots = np.array([[1, 2], [3, 2], [4, 3], [1, 1]])\n\nt = np.linspace(0, n_knots, 100)\nvals = spline.eval(t, derivative=0)\n\nplt.scatter(spline.knots[:, 0], spline.knots[:, 1])\nplt.plot(vals[:, 0], vals[:, 1])\nplt.show()\n```\n\n## Support\n\nIf you encounter any problems, please [file and issue](https://github.com/EPFL-Center-for-Imaging/splinebox/issues/new) describing the issue and include minimal example to reproduce the issue.\n\n## Contributing\n\nWe welcome contributions! Before you submit a pull request, please ensure that the tests are passing. You can run the tests with [pytest](https://docs.pytest.org/en/stable/). If you are unsure how to implement something, feel free to open an issue to discuss.\n\n## Citing splinebox\n\nIf you use splinebox in the context of scientific publication, please cite it as follows.\nNote, that you will have to fill in the version yourself. If you are unsure what version you are running,\nyou can find out by running\n\n```python\nimport splinebox\nprint(splinbox.__version__)`\n```\n\nBibTeX:\n\n```\n@misc{splinebox,\n author = {Aymanns, Florian and And\u00f2, Edward and Uhlmann, Virginie},\n title = {{S}pline{B}ox},\n url = {https://pypi.org/project/splinebox/},\n doi = {10.5281/zenodo.13358354},\n note = {{V}ersion V.V.Vb1},\n year = 2024,\n}\n```\n\n\n## License\n\nThis is an open source project licensed under the BSD-3-Clause License.\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c) 2024, EPFL Center for Imaging 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": "A python package for fitting splines.",
"version": "0.3.0",
"project_urls": {
"Repository": "https://github.com/EPFL-Center-for-Imaging/splinebox"
},
"split_keywords": [
"splines"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a64b4f5019d8c45241c7df1624bcf9f63395cb4d7d95792134b24fa45e88b9e8",
"md5": "9820b0780307bcaf74e87990fd3768c7",
"sha256": "753e14726fb3049c5785008fdc9e7b16ed87770242370371a4862f5621d7b262"
},
"downloads": -1,
"filename": "splinebox-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9820b0780307bcaf74e87990fd3768c7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 24962,
"upload_time": "2025-01-08T09:18:34",
"upload_time_iso_8601": "2025-01-08T09:18:34.479366Z",
"url": "https://files.pythonhosted.org/packages/a6/4b/4f5019d8c45241c7df1624bcf9f63395cb4d7d95792134b24fa45e88b9e8/splinebox-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "48405c1812a3e7c0423a0066d405258da75ec376e5538c96c54cff192042f072",
"md5": "5a85c99efe1aeb235cedaed86f14adef",
"sha256": "1836c820dbcf75652059c42f213ef1483658fc8973c25401d47dd7b0f0fecb29"
},
"downloads": -1,
"filename": "splinebox-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "5a85c99efe1aeb235cedaed86f14adef",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 1582891,
"upload_time": "2025-01-08T09:18:36",
"upload_time_iso_8601": "2025-01-08T09:18:36.998590Z",
"url": "https://files.pythonhosted.org/packages/48/40/5c1812a3e7c0423a0066d405258da75ec376e5538c96c54cff192042f072/splinebox-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-08 09:18:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "EPFL-Center-for-Imaging",
"github_project": "splinebox",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "splinebox"
}
