.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "generated_examples/spice.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        :ref:`Go to the end <sphx_glr_download_generated_examples_spice.py>`
        to download the full example code.

.. rst-class:: sphx-glr-example-title

.. _sphx_glr_generated_examples_spice.py:


Using SPICE kernels with hermpy
===============================

In this example, we show how ``hermpy.net.ClientSPICE`` can be used to
download, access, and use SPICE kernels from multiple sources.

.. GENERATED FROM PYTHON SOURCE LINES 8-13

.. code-block:: Python


    import datetime as dt

    import spiceypy as spice








.. GENERATED FROM PYTHON SOURCE LINES 14-20

``hermpy.net`` introduces a client to handle the caching and fetching of
SPICE kernels.

There are some default kernels included by default, but more can be added on
the fly. If you feel your additions would make sense as permanent inclusion,
please open a PR.

.. GENERATED FROM PYTHON SOURCE LINES 20-24

.. code-block:: Python

    from hermpy.net import ClientSPICE

    spice_client = ClientSPICE()








.. GENERATED FROM PYTHON SOURCE LINES 25-36

Adding kernels
--------------
Kernels can be added to the SPICE client through updating the
``KERNEL_LOCATIONS`` dictionary. ``KERNEL_LOCATIONS`` expects the format seen
below, with a base url (``BASE``), a subdirectory (``DIRECTORY``), and a list
of filepatterns to search for (``PATTERNS``). The outermost key is purely to
help describe the addition and is not used internally. Character wildcards
are represented as '?'.

Here we show an example of adding MESSENGER mission kernels, and a coordinate
system kernel defined for the BepiColombo mission.

.. GENERATED FROM PYTHON SOURCE LINES 36-56

.. code-block:: Python

    spice_client.KERNEL_LOCATIONS.update(
        {
            "MESSENGER Frames (tf)": {
                "BASE": "https://naif.jpl.nasa.gov/pub/naif/",
                "DIRECTORY": "pds/data/mess-e_v_h-spice-6-v1.0/messsp_1000/data/fk/",
                "PATTERNS": ["msgr_dyn_v600.tf"],
            },
            "MESSENGER": {
                "BASE": "https://naif.jpl.nasa.gov/pub/naif/",
                "DIRECTORY": "pds/data/mess-e_v_h-spice-6-v1.0/messsp_1000/data/spk/",
                "PATTERNS": ["msgr_??????_??????_??????_od431sc_2.bsp"],
            },
            "BepiColombo Frames": {
                "BASE": "https://naif.jpl.nasa.gov/pub/naif/",
                "DIRECTORY": "pds/pds4/bc/bc_spice/spice_kernels/fk/",
                "PATTERNS": ["bc_sci_v12.tf"],
            },
        }
    )








.. GENERATED FROM PYTHON SOURCE LINES 57-61

Loading kernels with ``spiceypy``
---------------------------------
We open a context in which we load kernels from ``ClientSPICE``. For more details
see the ``spiceypy documentation.

.. GENERATED FROM PYTHON SOURCE LINES 61-67

.. code-block:: Python

    with spice.KernelPool(spice_client.fetch()):
        et = spice.datetime2et(dt.datetime(2012, 6, 1))
        position, _ = spice.spkpos("MESSENGER", et, "BC_MSO_AB", "NONE", "Mercury")

        print(position)





.. rst-class:: sphx-glr-script-out

 .. code-block:: none


    Files Downloaded:   0%|          | 0/8 [00:00<?, ?file/s]


    naif0012.tls:   0%|          | 0.00/5.26k [00:00<?, ?B/s]



    latest_leapseconds.tls:   0%|          | 0.00/5.26k [00:00<?, ?B/s]

    naif0011.tls:   0%|          | 0.00/5.09k [00:00<?, ?B/s]





    de442.bsp:   0%|          | 0.00/120M [00:00<?, ?B/s]




    pck00011.tpc:   0%|          | 0.00/131k [00:00<?, ?B/s]





    de442.bsp:   0%|          | 16.7k/120M [00:00<15:24, 130kB/s]


    naif0012.tls:  39%|███▉      | 2.08k/5.26k [00:00<00:00, 8.28kB/s]



    latest_leapseconds.tls:  39%|███▉      | 2.08k/5.26k [00:00<00:00, 8.25kB/s]


                                                                      
    Files Downloaded:  12%|█▎        | 1/8 [00:00<00:03,  1.98file/s]





    de442.bsp:   0%|          | 193k/120M [00:00<02:10, 919kB/s] 

    naif0011.tls:  40%|████      | 2.04k/5.09k [00:00<00:00, 8.21kB/s]



                                                                                

                                                                      




    pck00011.tpc:   1%|          | 1.02k/131k [00:00<00:32, 3.96kB/s]


    msgr_dyn_v600.tf:   0%|          | 0.00/25.0k [00:00<?, ?B/s]



    msgr_040803_150430_150430_od431sc_2.bsp:   0%|          | 0.00/685M [00:00<?, ?B/s]

    bc_sci_v12.tf:   0%|          | 0.00/44.1k [00:00<?, ?B/s]




                                                                     
    Files Downloaded:  50%|█████     | 4/8 [00:00<00:00,  7.85file/s]


                                                                 





    de442.bsp:   1%|          | 832k/120M [00:00<00:40, 2.92MB/s]

                                                              



    msgr_040803_150430_150430_od431sc_2.bsp:   0%|          | 40.1k/685M [00:00<35:22, 323kB/s]





    de442.bsp:   2%|▏         | 2.48M/120M [00:00<00:16, 7.18MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:   0%|          | 480k/685M [00:00<05:20, 2.13MB/s]





    de442.bsp:   6%|▌         | 7.14M/120M [00:00<00:05, 19.8MB/s]





    de442.bsp:   9%|▉         | 11.4M/120M [00:00<00:04, 26.8MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:   0%|          | 1.97M/685M [00:00<01:42, 6.69MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:   1%|          | 4.49M/685M [00:00<00:51, 13.1MB/s]





    de442.bsp:  14%|█▍        | 17.0M/120M [00:00<00:02, 35.0MB/s]





    de442.bsp:  18%|█▊        | 21.5M/120M [00:00<00:02, 37.8MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:   1%|          | 7.35M/685M [00:00<00:38, 17.6MB/s]





    de442.bsp:  21%|██        | 25.3M/120M [00:00<00:02, 38.0MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:   2%|▏         | 10.3M/685M [00:00<00:32, 21.0MB/s]





    de442.bsp:  25%|██▍       | 29.7M/120M [00:01<00:02, 37.8MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:   2%|▏         | 14.7M/685M [00:00<00:25, 26.5MB/s]





    de442.bsp:  29%|██▊       | 34.2M/120M [00:01<00:02, 38.9MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:   3%|▎         | 18.9M/685M [00:00<00:21, 30.3MB/s]





    de442.bsp:  33%|███▎      | 39.5M/120M [00:01<00:01, 41.3MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:   3%|▎         | 23.2M/685M [00:01<00:20, 32.7MB/s]





    de442.bsp:  37%|███▋      | 44.7M/120M [00:01<00:01, 42.7MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:   4%|▍         | 27.5M/685M [00:01<00:19, 34.2MB/s]





    de442.bsp:  42%|████▏     | 49.9M/120M [00:01<00:01, 43.9MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:   5%|▍         | 31.7M/685M [00:01<00:18, 35.4MB/s]





    de442.bsp:  46%|████▌     | 55.1M/120M [00:01<00:01, 44.5MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:   5%|▌         | 36.0M/685M [00:01<00:18, 36.0MB/s]





    de442.bsp:  50%|█████     | 60.4M/120M [00:01<00:01, 45.2MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:   6%|▌         | 40.3M/685M [00:01<00:17, 36.7MB/s]





    de442.bsp:  54%|█████▍    | 64.9M/120M [00:01<00:01, 45.0MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:   6%|▋         | 43.9M/685M [00:01<00:17, 36.7MB/s]





    de442.bsp:  58%|█████▊    | 69.4M/120M [00:02<00:01, 40.3MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:   7%|▋         | 47.6M/685M [00:01<00:19, 32.9MB/s]





    de442.bsp:  61%|██████▏   | 73.5M/120M [00:02<00:01, 40.0MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:   7%|▋         | 51.1M/685M [00:01<00:19, 32.7MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:   8%|▊         | 55.3M/685M [00:01<00:17, 35.3MB/s]





    de442.bsp:  66%|██████▌   | 78.6M/120M [00:02<00:00, 41.2MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:   9%|▊         | 59.9M/685M [00:02<00:16, 38.1MB/s]





    de442.bsp:  69%|██████▉   | 83.2M/120M [00:02<00:00, 42.5MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:   9%|▉         | 64.3M/685M [00:02<00:15, 39.9MB/s]





    de442.bsp:  73%|███████▎  | 87.5M/120M [00:02<00:00, 42.6MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  10%|█         | 68.6M/685M [00:02<00:15, 40.8MB/s]





    de442.bsp:  77%|███████▋  | 91.8M/120M [00:02<00:00, 42.5MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  11%|█         | 72.8M/685M [00:02<00:14, 41.1MB/s]





    de442.bsp:  80%|████████  | 96.0M/120M [00:02<00:00, 42.5MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  11%|█▏        | 77.4M/685M [00:02<00:14, 42.6MB/s]





    de442.bsp:  84%|████████▍ | 101M/120M [00:02<00:00, 41.1MB/s] 



    msgr_040803_150430_150430_od431sc_2.bsp:  12%|█▏        | 81.9M/685M [00:02<00:14, 41.2MB/s]





    de442.bsp:  88%|████████▊ | 105M/120M [00:02<00:00, 42.0MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  13%|█▎        | 86.2M/685M [00:02<00:14, 41.6MB/s]





    de442.bsp:  91%|█████████ | 109M/120M [00:02<00:00, 42.0MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  13%|█▎        | 90.5M/685M [00:02<00:14, 41.9MB/s]





    de442.bsp:  95%|█████████▍| 113M/120M [00:03<00:00, 41.9MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  14%|█▍        | 95.9M/685M [00:02<00:12, 45.4MB/s]





    de442.bsp:  98%|█████████▊| 118M/120M [00:03<00:00, 38.4MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  15%|█▌        | 103M/685M [00:02<00:11, 52.5MB/s] 





                                                                 
    Files Downloaded:  88%|████████▊ | 7/8 [00:03<00:00,  1.67file/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  16%|█▌        | 110M/685M [00:03<00:10, 57.2MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  17%|█▋        | 118M/685M [00:03<00:08, 65.2MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  18%|█▊        | 126M/685M [00:03<00:07, 70.1MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  20%|█▉        | 134M/685M [00:03<00:07, 70.0MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  21%|██        | 141M/685M [00:03<00:08, 65.4MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  22%|██▏       | 149M/685M [00:03<00:07, 70.0MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  23%|██▎       | 157M/685M [00:03<00:07, 73.9MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  24%|██▍       | 165M/685M [00:03<00:06, 74.4MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  25%|██▌       | 174M/685M [00:03<00:06, 78.7MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  27%|██▋       | 182M/685M [00:03<00:06, 78.4MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  28%|██▊       | 191M/685M [00:04<00:06, 80.9MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  29%|██▉       | 199M/685M [00:04<00:06, 80.0MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  30%|███       | 208M/685M [00:04<00:05, 81.3MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  32%|███▏      | 216M/685M [00:04<00:05, 80.6MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  33%|███▎      | 225M/685M [00:04<00:05, 83.4MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  34%|███▍      | 233M/685M [00:04<00:05, 81.5MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  35%|███▌      | 242M/685M [00:04<00:06, 70.9MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  37%|███▋      | 250M/685M [00:04<00:05, 73.6MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  38%|███▊      | 259M/685M [00:04<00:05, 77.3MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  39%|███▉      | 267M/685M [00:05<00:05, 78.3MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  40%|████      | 275M/685M [00:05<00:05, 77.8MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  41%|████▏     | 284M/685M [00:05<00:04, 80.8MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  43%|████▎     | 292M/685M [00:05<00:04, 79.5MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  44%|████▍     | 301M/685M [00:05<00:04, 81.8MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  45%|████▌     | 309M/685M [00:05<00:04, 80.2MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  46%|████▋     | 318M/685M [00:05<00:04, 82.3MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  48%|████▊     | 326M/685M [00:05<00:04, 80.9MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  49%|████▉     | 334M/685M [00:05<00:04, 81.6MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  50%|█████     | 342M/685M [00:06<00:04, 71.6MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  51%|█████     | 351M/685M [00:06<00:04, 74.5MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  53%|█████▎    | 360M/685M [00:06<00:04, 78.0MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  54%|█████▍    | 369M/685M [00:06<00:03, 80.2MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  55%|█████▌    | 378M/685M [00:06<00:03, 82.3MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  57%|█████▋    | 387M/685M [00:06<00:03, 83.1MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  58%|█████▊    | 396M/685M [00:06<00:03, 84.8MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  59%|█████▉    | 405M/685M [00:06<00:03, 83.3MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  60%|██████    | 413M/685M [00:06<00:03, 83.3MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  62%|██████▏   | 422M/685M [00:06<00:03, 84.9MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  63%|██████▎   | 431M/685M [00:07<00:03, 83.2MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  64%|██████▍   | 439M/685M [00:07<00:03, 81.6MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  65%|██████▌   | 447M/685M [00:07<00:03, 74.1MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  66%|██████▋   | 455M/685M [00:07<00:03, 74.7MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  68%|██████▊   | 463M/685M [00:07<00:02, 77.0MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  69%|██████▉   | 471M/685M [00:07<00:02, 77.8MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  70%|███████   | 480M/685M [00:07<00:02, 79.2MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  71%|███████▏  | 489M/685M [00:07<00:02, 81.6MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  73%|███████▎  | 498M/685M [00:07<00:02, 82.8MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  74%|███████▍  | 507M/685M [00:08<00:02, 83.3MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  75%|███████▌  | 516M/685M [00:08<00:02, 83.4MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  77%|███████▋  | 524M/685M [00:08<00:01, 83.2MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  78%|███████▊  | 532M/685M [00:08<00:01, 77.1MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  79%|███████▉  | 540M/685M [00:08<00:02, 67.9MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  80%|████████  | 549M/685M [00:08<00:01, 72.4MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  82%|████████▏ | 558M/685M [00:08<00:01, 76.8MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  83%|████████▎ | 566M/685M [00:08<00:01, 77.4MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  84%|████████▍ | 575M/685M [00:08<00:01, 81.0MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  85%|████████▌ | 583M/685M [00:09<00:01, 80.8MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  86%|████████▋ | 592M/685M [00:09<00:01, 81.8MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  88%|████████▊ | 601M/685M [00:09<00:01, 82.9MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  89%|████████▉ | 610M/685M [00:09<00:00, 84.9MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  90%|█████████ | 619M/685M [00:09<00:00, 84.8MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  92%|█████████▏| 627M/685M [00:09<00:00, 84.3MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  93%|█████████▎| 636M/685M [00:09<00:00, 83.9MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  94%|█████████▍| 644M/685M [00:09<00:00, 73.9MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  95%|█████████▌| 653M/685M [00:09<00:00, 76.8MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  97%|█████████▋| 661M/685M [00:10<00:00, 78.6MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  98%|█████████▊| 670M/685M [00:10<00:00, 80.2MB/s]



    msgr_040803_150430_150430_od431sc_2.bsp:  99%|█████████▉| 678M/685M [00:10<00:00, 74.4MB/s]



                                                                                               
    Files Downloaded: 100%|██████████| 8/8 [00:10<00:00,  1.97s/file]
    Files Downloaded: 100%|██████████| 8/8 [00:10<00:00,  1.37s/file]
    [-1111.54790425 -4790.21635147 -2979.94219262]




.. GENERATED FROM PYTHON SOURCE LINES 68-74

Loading kernels directly wit ``ClientSPICE``
--------------------------------------------
Equivalently (and often preferably), we define a context manager within
``ClientSPICE`` which extends the above. All that happens under the hood here
is that the spice client performs the fetch, passes it to spice.KernelPool(),
and yields the contextmanager.

.. GENERATED FROM PYTHON SOURCE LINES 74-79

.. code-block:: Python

    with spice_client.KernelPool():
        et = spice.datetime2et(dt.datetime(2012, 6, 1))
        position, _ = spice.spkpos("MESSENGER", et, "BC_MSO_AB", "NONE", "Mercury")

        print(position)




.. rst-class:: sphx-glr-script-out

 .. code-block:: none


    Files Downloaded:   0%|          | 0/16 [00:00<?, ?file/s]
    Files Downloaded:   6%|▋         | 1/16 [00:00<00:03,  3.82file/s]
    Files Downloaded:  69%|██████▉   | 11/16 [00:00<00:00, 34.85file/s]
    Files Downloaded: 100%|██████████| 16/16 [00:00<00:00, 35.68file/s]
    [-1111.54790425 -4790.21635147 -2979.94219262]





.. rst-class:: sphx-glr-timing

   **Total running time of the script:** (0 minutes 15.114 seconds)


.. _sphx_glr_download_generated_examples_spice.py:

.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-example

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download Jupyter notebook: spice.ipynb <spice.ipynb>`

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download Python source code: spice.py <spice.py>`

    .. container:: sphx-glr-download sphx-glr-download-zip

      :download:`Download zipped: spice.zip <spice.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_