Crate spice

rust-spice

WOW! The complete NASA/NAIF Spice toolkit is actually usable on Rust.

Requirements

1. Install [CSPICE library][cspice install link] for your platform.
2. Tell Cargo where to look for the CSPICE library. This is done by adding some lines to $HOME/.cargo/config.toml. If the file doesn’t exist, create it (read [Configuration doc][config doc]). You need to write:

[target.YOUR_PLATFORM.cspice]
rustc-link-lib = ["cspice"]
rustc-link-search = ["/path/to/cspice/lib"]
rustc-cdylib-link-arg = ["-I/path/to/cspice/include"]

replace YOUR_PLATFORM by either: + for linux: x86_64-unknown-linux-gnu + for mac: x86_64-apple-darwin + for windows: x86_64-pc-windows-msvc

and replace /path/to/cspice with the absolute path to your CSPICE installation.

Usage

Simply add the following to your Cargo.toml file:

[dependencies]
rust-spice = "*" // replace * by the latest version of the crate

Rust layered Spice functions of rust-spice are grouped in the root module spice:: and all functions from the FFI are grouped in spice::c::.

You can find a guide for the Rust interface here.

rust-spice in action

A nice and idiomatic interface to Spice,

use spice;

let mut kernel = spice::Kernel::new("/path/to/metakernels.mk")?;

let et = spice::str2et("2027-MAR-23 16:00:00");
let (position, light_time) = spice::spkpos("TARGET_NAME", et, "FRAME_NAME", "NONE", "SUN");

kernel.unload()?;

You can also read other examples.

In development

Developing an idiomatic interface for Spice in Rust takes time, and not all functions are implemented yet. In the module **core**, you will find a guide detailing which functions are available. If yours is not, you can always use the unsafe API which contains all cspice functions.

For instance, with the unsafe API, the example above would be,

use spice;
use std::ffi::CString;

unsafe {
    let kernel = CString::new("/path/to/metakernel.mk").unwrap().into_raw();
    spice::c::furnsh_c(kernel);

    let mut ephemeris_time = 0.0;
    let date = CString::new("2027-MAR-23 16:00:00").unwrap().into_raw();
    spice::c::str2et_c(date, &mut ephemeris_time);

    let target_c = CString::new("TARGET_NAME").unwrap().into_raw();
    let frame_c = CString::new("FRAME_NAME").unwrap().into_raw();
    let abcorr_c = CString::new("NONE").unwrap().into_raw();
    let observer_c = CString::new("SUN").unwrap().into_raw();
    let mut light_time = 0.0;
    let mut position = [0.0, 0.0, 0.0];
    spice::c::spkpos_c(
        target_c,
        ephemeris_time,
        frame_c,
        abcorr_c,
        observer_c,
        &mut position[0],
        &mut light_time,
    );

    spice::c::unload_c(kernel);
}

Re-exports

pub use crate::core::*;
pub use crate::spicetools::*;

Modules

c	Complete NASA/NAIF C SPICE binded functions, very unsafe.
core	An idiomatic Rust layer on top of the C wrapper.
spicetools	Extra tools developped on top of Spice for even easier usage of the library.

Macros

cstr	Convert String to *mut i8.