| Name | ccsdspy JSON |
| Version |
1.3.2
JSON |
| download |
| home_page | None |
| Summary | IO Interface for Reading CCSDS Data in Python. |
| upload_time | 2024-10-17 21:59:59 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.6 |
| license | Copyright (c) 2018, Daniel da Silva 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 ccsdspy project 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 |
python
nasa
ccsds
space packet protocol
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
CCSDSPy - IO Interface for Reading CCSDS Data in Python.
========================================================
.. image:: https://github.com/ccsdspy/ccsdspy/actions/workflows/ccsdspy-ci.yml/badge.svg
:target: https://github.com/ccsdspy/ccsdspy/actions
:alt: CI Status
.. image:: https://codecov.io/gh/ccsdspy/ccsdspy/branch/main/graph/badge.svg?token=Ia45f4cW8f
:target: https://codecov.io/gh/ccsdspy/ccsdspy
:alt: Code Coverage
.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.7819991.svg
:target: https://doi.org/10.5281/zenodo.7819991
:alt: Zenodo DOI
This community-developed package provides a Python interface for reading tightly packed bits in the `Consultative Committee for Space Data Systems (CCSDS) <https://public.ccsds.org/>`__ format used by many NASA and ESA missions. The library is developed with requirements sourced from the community and extensive automated testing.
Used By
-------
.. image:: https://raw.githubusercontent.com/ccsdspy/ccsdspy/main/docs/_static/used-by/small/goes-r.png
:target: https://www.goes-r.gov/
.. image:: https://raw.githubusercontent.com/ccsdspy/ccsdspy/main/docs/_static/used-by/small/europa-clipper.png
:target: https://europa.nasa.gov/
.. image:: https://raw.githubusercontent.com/ccsdspy/ccsdspy/main/docs/_static/used-by/small/mms.jpg
:target: https://mms.gsfc.nasa.gov/
.. image:: https://raw.githubusercontent.com/ccsdspy/ccsdspy/main/docs/_static/used-by/small/pace.png
:target: https://pace.gsfc.nasa.gov/
.. image:: https://raw.githubusercontent.com/ccsdspy/ccsdspy/main/docs/_static/used-by/small/hermes.png
:target: https://science.nasa.gov/missions/hermes
.. image:: https://raw.githubusercontent.com/ccsdspy/ccsdspy/main/docs/_static/used-by/small/csa.png
:target: https://www.asc-csa.gc.ca/eng/
.. image:: https://raw.githubusercontent.com/ccsdspy/ccsdspy/main/docs/_static/used-by/small/punch.png
:target: https://punch.space.swri.edu/
.. image:: https://raw.githubusercontent.com/ccsdspy/ccsdspy/main/docs/_static/used-by/small/spherex.png
:target: https://www.jpl.nasa.gov/missions/spherex
.. image:: https://raw.githubusercontent.com/ccsdspy/ccsdspy/main/docs/_static/used-by/small/elfin.jpg
:target: https://elfin.igpp.ucla.edu/
.. image:: https://raw.githubusercontent.com/ccsdspy/ccsdspy/main/docs/_static/used-by/small/padre.png
:target: https://padre.ssl.berkeley.edu
Do you know of other missions that use CCSDSPy? Let us know `through a github issue`_!
.. _through a github issue: https://github.com/ccsdspy/ccsdspy/issues/new
Installation
============
To install ccsdspy
.. code::
pip install ccsdspy
Usage Example
=============
The following example shows how simple it is to read in fixed length CCSDS packets.
.. code-block:: python
import ccsdspy
from ccsdspy import PacketField, PacketArray
pkt = ccsdspy.FixedLength([
PacketField(name='SHCOARSE', data_type='uint', bit_length=32),
PacketField(name='SHFINE', data_type='uint', bit_length=20),
PacketField(name='OPMODE', data_type='uint', bit_length=3),
PacketField(name='SPACER', data_type='fill', bit_length=1),
PacketField(name='VOLTAGE', data_type='int', bit_length=8),
PacketArray(
name='SENSOR_GRID',
data_type='uint',
bit_length=16,
array_shape=(32, 32),
array_order='C'
),
])
result = pkt.load('mypackets.bin')
Documentation
=============
Our documentation is hosted on readthedocs and can be found `here <https://ccsdspy.readthedocs.io/en/latest/>`__.
Getting Help
============
For more information or to ask questions about the library or CCSDS data in general, check out the `CCSDSPy Discussion Board <https://github.com/ccsdspy/ccsdspy/discussions>`__ hosted through GitHub.
Acknowledging or Citing ccsdspy
===============================
If you use ccsdspy, it would be appreciated if you let us know and mention it in your publications. The code can be cited using the `DOI provided by Zenodo <https://zenodo.org/record/7819991>`__. The continued growth and development of this package is dependent on the community being aware of it.
Code of Conduct
===============
When interacting with this package please behave consistent with the following `Code of Conduct <https://www.contributor-covenant.org/version/2/1/code_of_conduct/>`__.
Raw data
{
"_id": null,
"home_page": null,
"name": "ccsdspy",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "python, nasa, ccsds, space packet protocol",
"author": null,
"author_email": "Daniel da Silva <mail@danieldasilva.org>, Steven Christe <steven.d.christe@nasa.gov>",
"download_url": "https://files.pythonhosted.org/packages/1f/b5/1238b43f35d44bb634d29fe2c5cbd963df2043e32de832231570eb03d090/ccsdspy-1.3.2.tar.gz",
"platform": null,
"description": "CCSDSPy - IO Interface for Reading CCSDS Data in Python.\n========================================================\n\n.. image:: https://github.com/ccsdspy/ccsdspy/actions/workflows/ccsdspy-ci.yml/badge.svg\n :target: https://github.com/ccsdspy/ccsdspy/actions\n :alt: CI Status\n\n\n.. image:: https://codecov.io/gh/ccsdspy/ccsdspy/branch/main/graph/badge.svg?token=Ia45f4cW8f\n :target: https://codecov.io/gh/ccsdspy/ccsdspy\n :alt: Code Coverage\t \n \n\n.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.7819991.svg\n :target: https://doi.org/10.5281/zenodo.7819991\n :alt: Zenodo DOI\n\t \nThis community-developed package provides a Python interface for reading tightly packed bits in the `Consultative Committee for Space Data Systems (CCSDS) <https://public.ccsds.org/>`__ format used by many NASA and ESA missions. The library is developed with requirements sourced from the community and extensive automated testing.\n\nUsed By\n-------\n.. image:: https://raw.githubusercontent.com/ccsdspy/ccsdspy/main/docs/_static/used-by/small/goes-r.png\n :target: https://www.goes-r.gov/\n.. image:: https://raw.githubusercontent.com/ccsdspy/ccsdspy/main/docs/_static/used-by/small/europa-clipper.png\n :target: https://europa.nasa.gov/\t \n.. image:: https://raw.githubusercontent.com/ccsdspy/ccsdspy/main/docs/_static/used-by/small/mms.jpg\n :target: https://mms.gsfc.nasa.gov/\n.. image:: https://raw.githubusercontent.com/ccsdspy/ccsdspy/main/docs/_static/used-by/small/pace.png\n :target: https://pace.gsfc.nasa.gov/\n.. image:: https://raw.githubusercontent.com/ccsdspy/ccsdspy/main/docs/_static/used-by/small/hermes.png\n :target: https://science.nasa.gov/missions/hermes\n.. image:: https://raw.githubusercontent.com/ccsdspy/ccsdspy/main/docs/_static/used-by/small/csa.png\n :target: https://www.asc-csa.gc.ca/eng/\t \n.. image:: https://raw.githubusercontent.com/ccsdspy/ccsdspy/main/docs/_static/used-by/small/punch.png\n :target: https://punch.space.swri.edu/\n.. image:: https://raw.githubusercontent.com/ccsdspy/ccsdspy/main/docs/_static/used-by/small/spherex.png\n :target: https://www.jpl.nasa.gov/missions/spherex\n.. image:: https://raw.githubusercontent.com/ccsdspy/ccsdspy/main/docs/_static/used-by/small/elfin.jpg\n :target: https://elfin.igpp.ucla.edu/\n.. image:: https://raw.githubusercontent.com/ccsdspy/ccsdspy/main/docs/_static/used-by/small/padre.png\n :target: https://padre.ssl.berkeley.edu\n\nDo you know of other missions that use CCSDSPy? Let us know `through a github issue`_!\n\n.. _through a github issue: https://github.com/ccsdspy/ccsdspy/issues/new\n\nInstallation\n============\nTo install ccsdspy\n\n.. code::\n\n pip install ccsdspy\n\nUsage Example\n=============\nThe following example shows how simple it is to read in fixed length CCSDS packets.\n\n.. code-block:: python\n \n import ccsdspy\n from ccsdspy import PacketField, PacketArray\n \n pkt = ccsdspy.FixedLength([\n PacketField(name='SHCOARSE', data_type='uint', bit_length=32),\n PacketField(name='SHFINE', data_type='uint', bit_length=20),\n PacketField(name='OPMODE', data_type='uint', bit_length=3),\n PacketField(name='SPACER', data_type='fill', bit_length=1),\n PacketField(name='VOLTAGE', data_type='int', bit_length=8),\n PacketArray(\n name='SENSOR_GRID',\n data_type='uint',\n bit_length=16,\n array_shape=(32, 32),\n array_order='C'\n ),\n ])\n \n result = pkt.load('mypackets.bin')\n\nDocumentation\n=============\nOur documentation is hosted on readthedocs and can be found `here <https://ccsdspy.readthedocs.io/en/latest/>`__.\n\nGetting Help\n============\nFor more information or to ask questions about the library or CCSDS data in general, check out the `CCSDSPy Discussion Board <https://github.com/ccsdspy/ccsdspy/discussions>`__ hosted through GitHub.\n\nAcknowledging or Citing ccsdspy\n===============================\nIf you use ccsdspy, it would be appreciated if you let us know and mention it in your publications. The code can be cited using the `DOI provided by Zenodo <https://zenodo.org/record/7819991>`__. The continued growth and development of this package is dependent on the community being aware of it.\n\nCode of Conduct\n===============\nWhen interacting with this package please behave consistent with the following `Code of Conduct <https://www.contributor-covenant.org/version/2/1/code_of_conduct/>`__.\n",
"bugtrack_url": null,
"license": "Copyright (c) 2018, Daniel da Silva 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 ccsdspy project 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": "IO Interface for Reading CCSDS Data in Python.",
"version": "1.3.2",
"project_urls": null,
"split_keywords": [
"python",
" nasa",
" ccsds",
" space packet protocol"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1fb51238b43f35d44bb634d29fe2c5cbd963df2043e32de832231570eb03d090",
"md5": "bf42f8933ce4c4ad6e9c8786db8c4ef4",
"sha256": "faff0703b47e5996fb6a718aa3b9924e9d6700b7b8d73cc5785597675ba76979"
},
"downloads": -1,
"filename": "ccsdspy-1.3.2.tar.gz",
"has_sig": false,
"md5_digest": "bf42f8933ce4c4ad6e9c8786db8c4ef4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 7892055,
"upload_time": "2024-10-17T21:59:59",
"upload_time_iso_8601": "2024-10-17T21:59:59.741297Z",
"url": "https://files.pythonhosted.org/packages/1f/b5/1238b43f35d44bb634d29fe2c5cbd963df2043e32de832231570eb03d090/ccsdspy-1.3.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-17 21:59:59",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "ccsdspy"
}
