semvec/pypi-packages huggingface dataset:
pyvims 1.0.5
Python package to manipulate the Cassini VIMS data
License: BSD
Requires Python: >=3.6
Keywords: cassini, vims, titan

PyVIMS
======

|Build| |Python| |Status| |Version| |License|

|PyPI| |Binder| |Zenodo|

.. |Build| image:: https://github.com/seignovert/pyvims/workflows/Github%20Actions/badge.svg
        :target: https://github.com/seignovert/pyvims/actions?query=workflow%3AGithub%20Actions
.. |Python| image:: https://img.shields.io/pypi/pyversions/pyvims.svg?label=Python
        :target: https://pypi.org/project/pyvims
.. |Status| image:: https://img.shields.io/pypi/status/pyvims.svg?label=Status
        :target: https://pypi.org/project/pyvims
.. |Version| image:: https://img.shields.io/pypi/v/pyvims.svg?label=Version
        :target: https://pypi.org/project/pyvims
.. |License| image:: https://img.shields.io/pypi/l/pyvims.svg?label=License
        :target: https://pypi.org/project/pyvims
.. |PyPI| image:: https://img.shields.io/badge/PyPI-pyvims-blue.svg?logo=python&logoColor=white
        :target: https://pypi.org/project/pyvims
.. |Binder| image:: https://badgen.net/badge/Binder/Live%20Demo/blue?icon=terminal
        :target: https://mybinder.org/v2/gh/seignovert/pyvims/main?filepath=notebooks/playground.ipynb
.. |Zenodo| image:: https://zenodo.org/badge/126732857.svg
        :target: https://zenodo.org/badge/latestdoi/126732857


Python package to manipulate the Cassini VIMS data.


Install
-------

.. code:: bash

    pip install pyvims


Upgrade
-------

.. code:: bash

    pip install --upgrade pyvims


Examples
--------
To use, simply do:

.. code:: python

    >>> from pyvims import VIMS

    >>> cube = VIMS('1487096932_1')

    >>> cube
    <VIMS> Cube: 1487096932_1
    - Size: (42, 42)
    - Channel: IR
    - Mode: NORMAL
    - Start time: 2005-02-14 18:02:29.023000
    - Stop time: 2005-02-14 18:07:32.930000
    - Exposure: 0.16276 sec
    - Duration: 0:05:03.907000
    - Main target: TITAN
    - Flyby: T3

    >>> cube.time
    datetime.datetime(2005, 2, 14, 18, 5, 0, 976500)

    >>> cube.target_name
    'TITAN'

    >>> cube.NS, cube.NL
    (42, 42)

For more details, take a look to the
`static Jupyter NoteBook <https://nbviewer.jupyter.org/github/seignovert/pyvims/blob/main/notebooks/pyvims.ipynb>`_
where more examples of usage are provided. You can also try this
`live demo on Binder <https://mybinder.org/v2/gh/seignovert/pyvims/main?filepath=notebooks/playground.ipynb>`_.


Citation
--------
If you use this package for your research, please cite it as:

    Seignovert et al. - PyVIMS (Version 1.0.5) - `Zenodo`_

.. _`Zenodo`: https://zenodo.org/badge/latestdoi/126732857


Disclaimer
----------
This project is not supported or endorsed by either JPL or NASA.
The code is provided "as is", use at your own risk.