| Name | sunkit-instruments JSON |
| Version |
0.6.2
JSON |
| download |
| home_page | None |
| Summary | A SunPy-affiliated package for solar instruments |
| upload_time | 2025-07-10 04:51:44 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | Copyright (c) 2024, The SunPy Community
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* 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.
* Neither the name of the sunkit-instruments team 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 |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
A SunPy affiliated package for solar instrument-specific tools
--------------------------------------------------------------
.. image:: http://img.shields.io/badge/powered%20by-SunPy-orange.svg?style=flat
:target: http://www.sunpy.org
:alt: Powered by SunPy Badge
What is sunkit-instruments?
---------------------------
sunkit-instruments is a SunPy-affiliated package for solar instrument-specific tools.
Its purpose is not to be a repository for all tools for all instruments.
Instead it is intended to perform three main roles:
1. Hold instrument tools that are so few they do not warrant their own package;
2. Hold tools for instruments with no instrument team or the instrument team does not currently support solar applications;
3. Act as an incubator for instrument-specific tools that can evolve into a separate instrument package, backed by an instrument team.
For instrument teams, this package can act as a forum to engage with their user base and learn how to best develop their tools within the SunPy/scientific Python ecosystem.
It also lowers the barrier to publishing Python-based instrument tools by providing packaging and release infrastructure and support.
However should instrument teams want to develop at their own pace or provide a large number of tools,
they should consider starting their own package for full control.
We encourage and support instrument teams in choosing this route and hope they will still engage and collaborate with the SunPy and wider community during their development.
We point to the recent development of `aiapy <https://gitlab.com/LMSAL_HUB/aia_hub/aiapy>`__ as a great example of this type of collaboration.
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.
License
-------
This project is Copyright (c) The SunPy Developers and licensed under the terms of the BSD 3-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.
Code of Conduct
---------------
sunkit-instruments follows the SunPy Project's `Code of Conduct <https://sunpy.org/coc>`__
Raw data
{
"_id": null,
"home_page": null,
"name": "sunkit-instruments",
"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/dc/af/b468cd30ef03a38e1b9d96d1647e12faead192efbeccbfd253253ff726e2/sunkit_instruments-0.6.2.tar.gz",
"platform": null,
"description": "A SunPy affiliated package for solar instrument-specific tools\n--------------------------------------------------------------\n\n.. image:: http://img.shields.io/badge/powered%20by-SunPy-orange.svg?style=flat\n :target: http://www.sunpy.org\n :alt: Powered by SunPy Badge\n\nWhat is sunkit-instruments?\n---------------------------\n\nsunkit-instruments is a SunPy-affiliated package for solar instrument-specific tools.\nIts purpose is not to be a repository for all tools for all instruments.\nInstead it is intended to perform three main roles:\n\n1. Hold instrument tools that are so few they do not warrant their own package;\n2. Hold tools for instruments with no instrument team or the instrument team does not currently support solar applications;\n3. Act as an incubator for instrument-specific tools that can evolve into a separate instrument package, backed by an instrument team.\n\nFor instrument teams, this package can act as a forum to engage with their user base and learn how to best develop their tools within the SunPy/scientific Python ecosystem.\nIt also lowers the barrier to publishing Python-based instrument tools by providing packaging and release infrastructure and support.\nHowever should instrument teams want to develop at their own pace or provide a large number of tools,\nthey should consider starting their own package for full control.\nWe encourage and support instrument teams in choosing this route and hope they will still engage and collaborate with the SunPy and wider community during their development.\nWe point to the recent development of `aiapy <https://gitlab.com/LMSAL_HUB/aia_hub/aiapy>`__ as a great example of this type of collaboration.\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\nLicense\n-------\n\nThis project is Copyright (c) The SunPy Developers and licensed under the terms of the BSD 3-Clause license.\nThis 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.\n\nCode of Conduct\n---------------\n\nsunkit-instruments follows the SunPy Project's `Code of Conduct <https://sunpy.org/coc>`__\n",
"bugtrack_url": null,
"license": "Copyright (c) 2024, The SunPy Community\n All rights reserved.\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 * Redistributions of source code must retain the above copyright notice, this\n list of conditions and the following disclaimer.\n * Redistributions in binary form must reproduce the above copyright notice, this\n list of conditions and the following disclaimer in the documentation and/or\n other materials provided with the distribution.\n * Neither the name of the sunkit-instruments team nor the names of its contributors may be\n used to endorse or promote products derived from this software without\n specific prior written permission.\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": "A SunPy-affiliated package for solar instruments",
"version": "0.6.2",
"project_urls": {
"Changelog": "https://docs.sunpy.org/projects/sunkit-instruments/en/stable/whatsnew/changelog.html",
"Documentation": "https://docs.sunpy.org/projects/sunkit-instruments",
"Download": "https://pypi.org/project/sunkit-instruments",
"Homepage": "https://sunpy.org",
"Issue Tracker": "https://github.com/sunpy/sunkit-instruments/issues",
"Source Code": "https://github.com/sunpy/sunkit-instruments"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "021c86b344859b2b3d5d0fa314dcc51c74dae4326f1d099a3223113ae26fbf31",
"md5": "856da19051e9ea4d9ad52edcde426faa",
"sha256": "2519d0a1237764c15dee96f95223ad9720f5169800e91384f74d6d4d3eedf710"
},
"downloads": -1,
"filename": "sunkit_instruments-0.6.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "856da19051e9ea4d9ad52edcde426faa",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 7063788,
"upload_time": "2025-07-10T04:51:42",
"upload_time_iso_8601": "2025-07-10T04:51:42.621681Z",
"url": "https://files.pythonhosted.org/packages/02/1c/86b344859b2b3d5d0fa314dcc51c74dae4326f1d099a3223113ae26fbf31/sunkit_instruments-0.6.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "dcafb468cd30ef03a38e1b9d96d1647e12faead192efbeccbfd253253ff726e2",
"md5": "9cec3157f3d50a5e46d653459f83da28",
"sha256": "042362eaddb87ef25a6689d86a0f2b2dbf174597cc08b53ff626546634e665b1"
},
"downloads": -1,
"filename": "sunkit_instruments-0.6.2.tar.gz",
"has_sig": false,
"md5_digest": "9cec3157f3d50a5e46d653459f83da28",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 6960335,
"upload_time": "2025-07-10T04:51:44",
"upload_time_iso_8601": "2025-07-10T04:51:44.399143Z",
"url": "https://files.pythonhosted.org/packages/dc/af/b468cd30ef03a38e1b9d96d1647e12faead192efbeccbfd253253ff726e2/sunkit_instruments-0.6.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-10 04:51:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sunpy",
"github_project": "sunkit-instruments",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"circle": true,
"tox": true,
"lcname": "sunkit-instruments"
}
