Skip to main content

Python library to monkeypatch SpiceyPy to allow JSON kernels.

Project description

jsonspice

Python library to monkeypatch SpiceyPy to allow JSON kernels (and Python dictionaries).

CI Status last-commit

Description

The standard text kernel format for the SPICE Toolkit is the "PCK" file (with extension .tpc). Examples of these files can be seen here. The PCK file is a data file format that exists in no other domain. So, it may be more convenient to use a standard file format such as JSON, as well as native Python dictionaries. The jsonspice library allows you to do this by monkey patching SpiceyPy so that JSON kernels will "just work".

Installation

PyPi

pip install jsonspice

JSON kernel format

The following PCK file:

KPL/PCK

\begintext
An example kernel

\begindata
TIME3      = @1972-JAN-1
AAA        = 1
AAA       += 2
VARIABLE   = (1.0 2.0 3.0)
VARIABLE2  = 42.0

Has the equivalent JSON kernel representation:

// An example kernel
{
    "TIME3": "@1972-JAN-1",
    "AAA" : 1,
    "+AAA" : 2,
    "VARIABLE": [1.0, 2.0, 3.0],
    "VARIABLE2": 42.0
}

Some things to note about the JSON version:

  • Optional comments are supported (using the JSON5 library). Other than this, the file is a standard JSON file.
  • The SPICE "@" format for time variables is supported using a normal string that begins with the "@" character.
  • The SPICE "+=" assignment to append to an existing variable is supported by prepending the variable name with the "+" character.

Example usage

To use this library, if must be imported BEFORE SpiceyPy. Once that is done, the normal furnsh() method can be used.

import jsonspice  # import first to monkeypatch spiceypy
import spiceypy

# load a normal kernel
spiceypy.furnsh('de-403-masses.tpc')

# load a JSON kernel
spiceypy.furnsh('de-403-masses.json')

# also works with dicts:
spiceypy.furnsh({"BODY8_GM": 6836534.064})
spiceypy.furnsh({"time": '@1972-JAN-1'})
spiceypy.furnsh({"+abc": [4,5,6]})

See also

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jsonspice-1.0.1.tar.gz (71.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

jsonspice-1.0.1-py3-none-any.whl (5.3 kB view details)

Uploaded Python 3

File details

Details for the file jsonspice-1.0.1.tar.gz.

File metadata

  • Download URL: jsonspice-1.0.1.tar.gz
  • Upload date:
  • Size: 71.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for jsonspice-1.0.1.tar.gz
Algorithm Hash digest
SHA256 8053895298655c8d56962c9158b9c880227389928df73b617607ad075064b7e2
MD5 5e07133ba9d0deeb7ce6293f1ba92343
BLAKE2b-256 f4689ce7eaf2196760e58b204f4336f24f330bf75f67515ee357e2b81d4f5125

See more details on using hashes here.

Provenance

The following attestation bundles were made for jsonspice-1.0.1.tar.gz:

Publisher: publish.yml on jacobwilliams/jsonspice

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file jsonspice-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: jsonspice-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 5.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for jsonspice-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c8d41c914b363a9f460ea2aae9abe174997a83465ff415c98a799f403c585e57
MD5 cb6e0a80b7ca5c5bc06cf52dd81ee64e
BLAKE2b-256 803028d0ebb88f95e2254f7fe897355ea5b23b89caae54a028f0dedb1133d53f

See more details on using hashes here.

Provenance

The following attestation bundles were made for jsonspice-1.0.1-py3-none-any.whl:

Publisher: publish.yml on jacobwilliams/jsonspice

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page