| Name | sunraster JSON |
| Version |
0.6.1
JSON |
| download |
| home_page | None |
| Summary | sunraster is an open-source Python library that provides the tools to read in and analyze spectrogram data. |
| upload_time | 2025-08-13 00:33:24 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | Copyright (c) 2024, The SunPy Community
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.
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 |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
=========
sunraster
=========
|Latest Version| |codecov| |matrix| |DOI| |Powered by NumFOCUS| |Powered by SunPy|
.. |Latest Version| image:: https://img.shields.io/pypi/v/sunraster.svg
:target: https://pypi.python.org/pypi/sunraster/
.. |matrix| image:: https://img.shields.io/matrix/sunpy:openastronomy.org.svg?colorB=%23FE7900&label=Chat&logo=matrix&server_fqdn=openastronomy.modular.im
:target: https://openastronomy.element.io/#/room/#sunpy:openastronomy.org
.. |codecov| image:: https://codecov.io/gh/sunpy/sunraster/branch/main/graph/badge.svg
:target: https://codecov.io/gh/sunpy/sunraster
.. |DOI| image:: https://zenodo.org/badge/2165383.svg
:target: https://zenodo.org/badge/latestdoi/2165383
.. |Powered by NumFOCUS| image:: https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A
:target: https://numfocus.org
.. |Powered by SunPy| image:: https://img.shields.io/badge/powered%20by-SunPy-orange.svg?style=flat
:target: https://www.sunpy.org
``sunraster`` is an open-source Python library that provides the tools to read in and analyze spectrogram data.
Installation
============
An easy way to install ``sunraster`` is to do so with the anaconda distribution using the conda-forge channel, with the following command at the terminal:
.. code-block:: console
conda install --channel conda-forge sunraster
Another equally easy way to install ``sunraster`` is with pip:
.. code-block:: console
pip install sunraster
Developing
==========
If you want to develop ``sunraster`` you will need to install from GitHub.
We suggest you fork ``sunraster`` so you can work on it.
The best way to do this is to create a new python virtual environment (conda/pipenv or others) and then install the git version of ``sunraster``:
.. code:: bash
$ git clone https://github.com/<your username>/sunraster.git
$ cd sunraster
$ pip install -e .\[dev\]
For detailed installation instructions (aimed at installing ``sunpy``), see the `Newcomers' guide`_ in the sunpy docs.
Getting help
============
For more information or to ask questions about ``sunraster``, check out:
- `sunraster Documentation`_
- `sunpy Matrix Channel`_
- `sunpy Mailing List`_
.. _sunraster Documentation: https://docs.sunpy.org/projects/sunraster/en/latest/
.. _sunpy Matrix Channel: https://chat.openastronomy.org/#/room/#sunpy:openastronomy.org
.. _sunpy Mailing List: https://groups.google.com/forum/#!forum/sunpy
License
=======
This project is Copyright (c) The SunPy Community and licensed under
the terms of the BSD 2-Clause license. This package is based upon
the `Openastronomy packaging guide <https://github.com/OpenAstronomy/packaging-guide>`_
which is licensed under the BSD 3-clause licence. See the licenses folder for
more information.
Usage of Generative AI
======================
We expect authentic engagement in our community.
Be wary of posting output from Large Language Models or similar generative AI as comments on GitHub or any other platform, as such comments tend to be formulaic and low quality content.
If you use generative AI tools as an aid in developing code or documentation changes, ensure that you fully understand the proposed changes and can explain why they are the correct approach and an improvement to the current state.
Contributing
============
We love contributions! sunraster is open source,
built on open source, and we'd love to have you hang out in our community.
**Imposter syndrome disclaimer**: We want your help. No, really.
There may be a little voice inside your head that is telling you that you're not
ready to be an open source contributor; that your skills aren't nearly good
enough to contribute. What could you possibly offer a project like this one?
We assure you - the little voice in your head is wrong. If you can write code at
all, you can contribute code to open source. Contributing to open source
projects is a fantastic way to advance one's coding skills. Writing perfect code
isn't the measure of a good developer (that would disqualify all of us!); it's
trying to create something, making mistakes, and learning from those
mistakes. That's how we all improve, and we are happy to help others learn.
Being an open source contributor doesn't just mean writing code, either. You can
help out by writing documentation, tests, or even giving feedback about the
project (and yes - that includes giving feedback about the contribution
process). Some of these contributions may be the most valuable to the project as
a whole, because you're coming to the project with fresh eyes, so you can see
the errors and assumptions that seasoned contributors have glossed over.
For more information on contributing to sunraster, please read SunPy's `Newcomers' guide`_.
.. _SunPy mailing list: https://groups.google.com/forum/#!forum/sunpy
.. _Developers Guide: https://docs.sunpy.org/en/latest/dev_guide/index.html
.. _`#sunpy:openastronomy.org`: https://chat.openastronomy.org/#/room/#sunpy:openastronomy.org
.. _issues page: https://github.com/sunpy/sunraster/issues
.. _Newcomers' guide: https://docs.sunpy.org/en/latest/dev_guide/contents/newcomers.html
Note: This disclaimer was originally written by
`Adrienne Lowe <https://github.com/adriennefriend>`_ for a
`PyCon talk <https://www.youtube.com/watch?v=6Uj746j9Heo>`_, and was adapted by
sunraster based on its use in the README file for the
`MetPy project <https://github.com/Unidata/MetPy>`_.
Raw data
{
"_id": null,
"home_page": null,
"name": "sunraster",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "The SunPy Community <sunpy@googlegroups.com>",
"download_url": "https://files.pythonhosted.org/packages/ba/a1/321b4d28ff9abd7ebcfbe54a184afe784d9271a6bbce5d0048fcb32698e8/sunraster-0.6.1.tar.gz",
"platform": null,
"description": "=========\nsunraster\n=========\n\n|Latest Version| |codecov| |matrix| |DOI| |Powered by NumFOCUS| |Powered by SunPy|\n\n.. |Latest Version| image:: https://img.shields.io/pypi/v/sunraster.svg\n :target: https://pypi.python.org/pypi/sunraster/\n.. |matrix| image:: https://img.shields.io/matrix/sunpy:openastronomy.org.svg?colorB=%23FE7900&label=Chat&logo=matrix&server_fqdn=openastronomy.modular.im\n :target: https://openastronomy.element.io/#/room/#sunpy:openastronomy.org\n.. |codecov| image:: https://codecov.io/gh/sunpy/sunraster/branch/main/graph/badge.svg\n :target: https://codecov.io/gh/sunpy/sunraster\n.. |DOI| image:: https://zenodo.org/badge/2165383.svg\n :target: https://zenodo.org/badge/latestdoi/2165383\n.. |Powered by NumFOCUS| image:: https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A\n :target: https://numfocus.org\n.. |Powered by SunPy| image:: https://img.shields.io/badge/powered%20by-SunPy-orange.svg?style=flat\n :target: https://www.sunpy.org\n\n``sunraster`` is an open-source Python library that provides the tools to read in and analyze spectrogram data.\n\nInstallation\n============\n\nAn easy way to install ``sunraster`` is to do so with the anaconda distribution using the conda-forge channel, with the following command at the terminal:\n\n.. code-block:: console\n\n conda install --channel conda-forge sunraster\n\nAnother equally easy way to install ``sunraster`` is with pip:\n\n.. code-block:: console\n\n pip install sunraster\n\nDeveloping\n==========\n\nIf you want to develop ``sunraster`` you will need to install from GitHub.\nWe suggest you fork ``sunraster`` so you can work on it.\nThe best way to do this is to create a new python virtual environment (conda/pipenv or others) and then install the git version of ``sunraster``:\n\n.. code:: bash\n\n $ git clone https://github.com/<your username>/sunraster.git\n $ cd sunraster\n $ pip install -e .\\[dev\\]\n\n\nFor detailed installation instructions (aimed at installing ``sunpy``), see the `Newcomers' guide`_ in the sunpy docs.\n\nGetting help\n============\n\nFor more information or to ask questions about ``sunraster``, check out:\n\n- `sunraster Documentation`_\n- `sunpy Matrix Channel`_\n- `sunpy Mailing List`_\n\n.. _sunraster Documentation: https://docs.sunpy.org/projects/sunraster/en/latest/\n.. _sunpy Matrix Channel: https://chat.openastronomy.org/#/room/#sunpy:openastronomy.org\n.. _sunpy Mailing List: https://groups.google.com/forum/#!forum/sunpy\n\n\nLicense\n=======\n\nThis project is Copyright (c) The SunPy Community and licensed under\nthe terms of the BSD 2-Clause license. This package is based upon\nthe `Openastronomy packaging guide <https://github.com/OpenAstronomy/packaging-guide>`_\nwhich is licensed under the BSD 3-clause licence. See the licenses folder for\nmore information.\n\nUsage of Generative AI\n======================\n\nWe expect authentic engagement in our community.\nBe wary of posting output from Large Language Models or similar generative AI as comments on GitHub or any other platform, as such comments tend to be formulaic and low quality content.\nIf you use generative AI tools as an aid in developing code or documentation changes, ensure that you fully understand the proposed changes and can explain why they are the correct approach and an improvement to the current state.\n\nContributing\n============\n\nWe love contributions! sunraster is open source,\nbuilt on open source, and we'd love to have you hang out in our community.\n\n**Imposter syndrome disclaimer**: We want your help. No, really.\n\nThere may be a little voice inside your head that is telling you that you're not\nready to be an open source contributor; that your skills aren't nearly good\nenough to contribute. What could you possibly offer a project like this one?\n\nWe assure you - the little voice in your head is wrong. If you can write code at\nall, you can contribute code to open source. Contributing to open source\nprojects is a fantastic way to advance one's coding skills. Writing perfect code\nisn't the measure of a good developer (that would disqualify all of us!); it's\ntrying to create something, making mistakes, and learning from those\nmistakes. That's how we all improve, and we are happy to help others learn.\n\nBeing an open source contributor doesn't just mean writing code, either. You can\nhelp out by writing documentation, tests, or even giving feedback about the\nproject (and yes - that includes giving feedback about the contribution\nprocess). Some of these contributions may be the most valuable to the project as\na whole, because you're coming to the project with fresh eyes, so you can see\nthe errors and assumptions that seasoned contributors have glossed over.\n\nFor more information on contributing to sunraster, please read SunPy's `Newcomers' guide`_.\n\n.. _SunPy mailing list: https://groups.google.com/forum/#!forum/sunpy\n.. _Developers Guide: https://docs.sunpy.org/en/latest/dev_guide/index.html\n.. _`#sunpy:openastronomy.org`: https://chat.openastronomy.org/#/room/#sunpy:openastronomy.org\n.. _issues page: https://github.com/sunpy/sunraster/issues\n.. _Newcomers' guide: https://docs.sunpy.org/en/latest/dev_guide/contents/newcomers.html\n\n\nNote: This disclaimer was originally written by\n`Adrienne Lowe <https://github.com/adriennefriend>`_ for a\n`PyCon talk <https://www.youtube.com/watch?v=6Uj746j9Heo>`_, and was adapted by\nsunraster based on its use in the README file for the\n`MetPy project <https://github.com/Unidata/MetPy>`_.\n",
"bugtrack_url": null,
"license": "Copyright (c) 2024, The SunPy Community\n \n Redistribution and use in source and binary forms, with or without modification,\n are permitted provided that the following conditions are met:\n \n 1. Redistributions of source code must retain the above copyright notice, this\n list of conditions and the following disclaimer.\n \n 2. Redistributions in binary form must reproduce the above copyright notice,\n this list of conditions and the following disclaimer in the documentation\n and/or other materials provided with the distribution.\n \n THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND\n ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED\n WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\n DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR\n ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES\n (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;\n LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON\n ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\n (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\n SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n ",
"summary": "sunraster is an open-source Python library that provides the tools to read in and analyze spectrogram data.",
"version": "0.6.1",
"project_urls": {
"Changelog": "https://docs.sunpy.org/projects/sunraster/en/stable/whatsnew/changelog.html",
"Documentation": "https://docs.sunpy.org/projects/sunraster",
"Download": "https://pypi.org/project/sunraster",
"Homepage": "https://sunpy.org",
"Issue Tracker": "https://github.com/sunpy/sunraster/issues",
"Source Code": "https://github.com/sunpy/sunraster"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "64747f6d54a63bbe492469ad6636de3554968ed90379bccbfc3dacca2333b4c4",
"md5": "f12cbacd0c2abce11ea360db9ec97e18",
"sha256": "9641e6e9ca04f94a3d7bb9f0ce33313e55c4404e8e4dbf63dc9218780a2256c5"
},
"downloads": -1,
"filename": "sunraster-0.6.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f12cbacd0c2abce11ea360db9ec97e18",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 49512,
"upload_time": "2025-08-13T00:33:23",
"upload_time_iso_8601": "2025-08-13T00:33:23.778174Z",
"url": "https://files.pythonhosted.org/packages/64/74/7f6d54a63bbe492469ad6636de3554968ed90379bccbfc3dacca2333b4c4/sunraster-0.6.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "baa1321b4d28ff9abd7ebcfbe54a184afe784d9271a6bbce5d0048fcb32698e8",
"md5": "4e000e6192843b44eaf39adab9fdcbba",
"sha256": "f9890cabe2ebebfd0ee5f7c6206d6e6515728102c09b9e4ac5a1128b4a3a3c28"
},
"downloads": -1,
"filename": "sunraster-0.6.1.tar.gz",
"has_sig": false,
"md5_digest": "4e000e6192843b44eaf39adab9fdcbba",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 76142,
"upload_time": "2025-08-13T00:33:24",
"upload_time_iso_8601": "2025-08-13T00:33:24.686553Z",
"url": "https://files.pythonhosted.org/packages/ba/a1/321b4d28ff9abd7ebcfbe54a184afe784d9271a6bbce5d0048fcb32698e8/sunraster-0.6.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-13 00:33:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sunpy",
"github_project": "sunraster",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "sunraster"
}
