| Name | sleplet JSON |
| Version |
1.4.11
JSON |
| download |
| home_page | None |
| Summary | Slepian Scale-Discretised Wavelets in Python |
| upload_time | 2024-07-01 09:21:53 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | BSD 3-Clause Licence Copyright (c) 2017-2024, Patrick Roddy 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 |
manifolds
python
slepian-functions
sphere
wavelets
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# SLEPLET
[](https://pypi.org/project/sleplet)
[](https://doi.org/10.5281/zenodo.7268074)
[](https://astro-informatics.github.io/sleplet)
[](https://github.com/astro-informatics/sleplet?tab=BSD-3-Clause-1-ov-file#readme)
[](https://www.python.org)
[](https://www.repostatus.org/#active)
[](https://github.com/astro-informatics/sleplet/actions/workflows/test.yaml)
[](https://coveralls.io/github/astro-informatics/sleplet?branch=main)
[](https://joss.theoj.org/papers/55d9cf16a27bf2d3141f0f66c676b7f2)
[](https://github.com/pyOpenSci/software-submission/issues/149)
[](https://github.com/astro-informatics/sleplet#citing)
[](https://github.com/pre-commit/pre-commit)
[](https://renovatebot.com)
`SLEPLET` is a Python package for the construction of Slepian wavelets in the
spherical and manifold (via meshes) settings. The API of `SLEPLET` has been
designed in an object-orientated manner and is easily extendible. Upon
installation, `SLEPLET` comes with two command line interfaces - `sphere` and
`mesh` - which allows one to easily generate plots on the sphere and a set of
meshes using `plotly`.
To read more about Slepian wavelets please see the following publications
[](https://dx.doi.org/10.1109/LSP.2021.3050961)
[](https://dx.doi.org/10.1109/TSP.2022.3233309)
[](https://doi.org/10.48550/arXiv.2302.06006)
[](https://paddyroddy.github.io/thesis)
## Installation
The recommended way to install `SLEPLET` is via
[pip](https://pypi.org/project/pip)
```sh
pip install sleplet
```
To install the latest development version of `SLEPLET` clone this repository and
run
```sh
pip install -e .
```
This will install two scripts `sphere` and `mesh` which can be used to generate
the figures in
[the associated papers](https://astro-informatics.github.io/sleplet#paper-figures).
### Supported Platforms
`SLEPLET` has been tested with
[](https://www.python.org).
Windows is not currently supported as `SLEPLET` relies on
[pyssht](https://pypi.org/project/pyssht) and
[pys2let](https://pypi.org/project/pys2let) which do not work on Windows. These
can hopefully be replaced with
[s2fft](https://github.com/astro-informatics/s2fft) and
[s2wav](https://github.com/astro-informatics/s2wav) in the future when they are
available on [PyPI](https://pypi.org).
## Example Usage
`SLEPLET` may be interacted with via the API or the CLIs.
### API Usage
The following demonstrates the first wavelet (ignoring the scaling function) of
the South America region on the sphere.
```python
import sleplet
B, J, J_MIN, L = 3, 0, 2, 128
region = sleplet.slepian.Region(mask_name="south_america")
f = sleplet.functions.SlepianWavelets(L, region=region, B=B, j_min=J_MIN, j=J)
f_sphere = sleplet.slepian_methods.slepian_inverse(f.coefficients, f.L, f.slepian)
sleplet.plotting.PlotSphere(
f_sphere,
f.L,
f"slepian_wavelets_south_america_{B}B_{J_MIN}jmin_{J_MIN+J}j_L{L}",
normalise=False,
region=f.region,
).execute()
```
### CLI Usage
The demonstrates the first wavelet (ignoring the scaling function) of the head
region of a Homer Simpson mesh for a per-vertex normals field.
```sh
mesh homer -e 3 2 0 -m slepian_wavelet_coefficients -u -z
```
## Documentation
See here for the [documentation](https://astro-informatics.github.io/sleplet).
This includes demonstrations of the figures from the associated papers along
with the API documentation. Further examples are included in the
[examples folder](https://github.com/astro-informatics/sleplet/tree/main/examples).
## Community Guidelines
We'd love any contributions you may have, please see the
[contributing guidelines](https://github.com/astro-informatics/sleplet/blob/main/CONTRIBUTING.md).
## Citing
If you use `SLEPLET` in your research, please cite the paper.
```bibtex
@article{Roddy2023,
title = {{SLEPLET: Slepian Scale-Discretised Wavelets in Python}},
author = {Roddy, Patrick J.},
year = 2023,
journal = {Journal of Open Source Software},
volume = 8,
number = 84,
pages = 5221,
doi = {10.21105/joss.05221},
}
```
Please also cite [S2LET](https://doi.org/10.1051/0004-6361/201220729) upon which
`SLEPLET` is built, along with [SSHT](https://doi.org/10.1109/TSP.2011.2166394)
in the spherical setting or [libigl](https://doi.org/10.1145/3134472.3134497) in
the mesh setting.
Raw data
{
"_id": null,
"home_page": null,
"name": "sleplet",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "manifolds, python, slepian-functions, sphere, wavelets",
"author": null,
"author_email": "\"Patrick J. Roddy\" <patrickjamesroddy@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/3d/a0/56ffb174266e08b68df42d54190d18e0887794613bc21eabc4b4d3e29ef4/sleplet-1.4.11.tar.gz",
"platform": null,
"description": "# SLEPLET\n\n[](https://pypi.org/project/sleplet)\n[](https://doi.org/10.5281/zenodo.7268074)\n[](https://astro-informatics.github.io/sleplet)\n[](https://github.com/astro-informatics/sleplet?tab=BSD-3-Clause-1-ov-file#readme)\n\n[](https://www.python.org)\n[](https://www.repostatus.org/#active)\n[](https://github.com/astro-informatics/sleplet/actions/workflows/test.yaml)\n[](https://coveralls.io/github/astro-informatics/sleplet?branch=main)\n\n[](https://joss.theoj.org/papers/55d9cf16a27bf2d3141f0f66c676b7f2)\n[](https://github.com/pyOpenSci/software-submission/issues/149)\n[](https://github.com/astro-informatics/sleplet#citing)\n\n[](https://github.com/pre-commit/pre-commit)\n[](https://renovatebot.com)\n\n`SLEPLET` is a Python package for the construction of Slepian wavelets in the\nspherical and manifold (via meshes) settings. The API of `SLEPLET` has been\ndesigned in an object-orientated manner and is easily extendible. Upon\ninstallation, `SLEPLET` comes with two command line interfaces - `sphere` and\n`mesh` - which allows one to easily generate plots on the sphere and a set of\nmeshes using `plotly`.\n\nTo read more about Slepian wavelets please see the following publications\n\n[](https://dx.doi.org/10.1109/LSP.2021.3050961)\n[](https://dx.doi.org/10.1109/TSP.2022.3233309)\n[](https://doi.org/10.48550/arXiv.2302.06006)\n[](https://paddyroddy.github.io/thesis)\n\n## Installation\n\nThe recommended way to install `SLEPLET` is via\n[pip](https://pypi.org/project/pip)\n\n```sh\npip install sleplet\n```\n\nTo install the latest development version of `SLEPLET` clone this repository and\nrun\n\n```sh\npip install -e .\n```\n\nThis will install two scripts `sphere` and `mesh` which can be used to generate\nthe figures in\n[the associated papers](https://astro-informatics.github.io/sleplet#paper-figures).\n\n### Supported Platforms\n\n`SLEPLET` has been tested with\n[](https://www.python.org).\nWindows is not currently supported as `SLEPLET` relies on\n[pyssht](https://pypi.org/project/pyssht) and\n[pys2let](https://pypi.org/project/pys2let) which do not work on Windows. These\ncan hopefully be replaced with\n[s2fft](https://github.com/astro-informatics/s2fft) and\n[s2wav](https://github.com/astro-informatics/s2wav) in the future when they are\navailable on [PyPI](https://pypi.org).\n\n## Example Usage\n\n`SLEPLET` may be interacted with via the API or the CLIs.\n\n### API Usage\n\nThe following demonstrates the first wavelet (ignoring the scaling function) of\nthe South America region on the sphere.\n\n```python\nimport sleplet\n\nB, J, J_MIN, L = 3, 0, 2, 128\n\nregion = sleplet.slepian.Region(mask_name=\"south_america\")\nf = sleplet.functions.SlepianWavelets(L, region=region, B=B, j_min=J_MIN, j=J)\nf_sphere = sleplet.slepian_methods.slepian_inverse(f.coefficients, f.L, f.slepian)\nsleplet.plotting.PlotSphere(\n f_sphere,\n f.L,\n f\"slepian_wavelets_south_america_{B}B_{J_MIN}jmin_{J_MIN+J}j_L{L}\",\n normalise=False,\n region=f.region,\n).execute()\n```\n\n\n\n### CLI Usage\n\nThe demonstrates the first wavelet (ignoring the scaling function) of the head\nregion of a Homer Simpson mesh for a per-vertex normals field.\n\n```sh\nmesh homer -e 3 2 0 -m slepian_wavelet_coefficients -u -z\n```\n\n\n\n## Documentation\n\nSee here for the [documentation](https://astro-informatics.github.io/sleplet).\nThis includes demonstrations of the figures from the associated papers along\nwith the API documentation. Further examples are included in the\n[examples folder](https://github.com/astro-informatics/sleplet/tree/main/examples).\n\n## Community Guidelines\n\nWe'd love any contributions you may have, please see the\n[contributing guidelines](https://github.com/astro-informatics/sleplet/blob/main/CONTRIBUTING.md).\n\n## Citing\n\nIf you use `SLEPLET` in your research, please cite the paper.\n\n```bibtex\n@article{Roddy2023,\n title = {{SLEPLET: Slepian Scale-Discretised Wavelets in Python}},\n author = {Roddy, Patrick J.},\n year = 2023,\n journal = {Journal of Open Source Software},\n volume = 8,\n number = 84,\n pages = 5221,\n doi = {10.21105/joss.05221},\n}\n```\n\nPlease also cite [S2LET](https://doi.org/10.1051/0004-6361/201220729) upon which\n`SLEPLET` is built, along with [SSHT](https://doi.org/10.1109/TSP.2011.2166394)\nin the spherical setting or [libigl](https://doi.org/10.1145/3134472.3134497) in\nthe mesh setting.\n",
"bugtrack_url": null,
"license": "BSD 3-Clause Licence Copyright (c) 2017-2024, Patrick Roddy 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": "Slepian Scale-Discretised Wavelets in Python",
"version": "1.4.11",
"project_urls": {
"Code": "https://github.com/astro-informatics/sleplet",
"Documentation": "https://astro-informatics.github.io/sleplet",
"Download": "https://pypi.org/project/sleplet",
"Homepage": "https://github.com/astro-informatics/sleplet",
"Issues": "https://github.com/astro-informatics/sleplet/issues"
},
"split_keywords": [
"manifolds",
" python",
" slepian-functions",
" sphere",
" wavelets"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9a91c2763217f07d191cbb860b36f1c59d45848462d3fa0994342d40e3a697fb",
"md5": "a531639515ab0608f015a74424773f00",
"sha256": "83f543023d598ad3ff4c12f41ff643ea41ea22c09c63b7b9a630808ea9600ade"
},
"downloads": -1,
"filename": "sleplet-1.4.11-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a531639515ab0608f015a74424773f00",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 386456,
"upload_time": "2024-07-01T09:21:51",
"upload_time_iso_8601": "2024-07-01T09:21:51.860050Z",
"url": "https://files.pythonhosted.org/packages/9a/91/c2763217f07d191cbb860b36f1c59d45848462d3fa0994342d40e3a697fb/sleplet-1.4.11-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3da056ffb174266e08b68df42d54190d18e0887794613bc21eabc4b4d3e29ef4",
"md5": "55573ece6f9a871d818457fd153004a9",
"sha256": "29b54beac65e699125562112be57a157b297fec0620b3e4ae3d2f00c0def28cb"
},
"downloads": -1,
"filename": "sleplet-1.4.11.tar.gz",
"has_sig": false,
"md5_digest": "55573ece6f9a871d818457fd153004a9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 350388,
"upload_time": "2024-07-01T09:21:53",
"upload_time_iso_8601": "2024-07-01T09:21:53.379119Z",
"url": "https://files.pythonhosted.org/packages/3d/a0/56ffb174266e08b68df42d54190d18e0887794613bc21eabc4b4d3e29ef4/sleplet-1.4.11.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-01 09:21:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "astro-informatics",
"github_project": "sleplet",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "sleplet"
}
