icc-dev

Contains MATLAB simulation and optimization code for spacecraft orbiting small Solar System Bodies.

Quickstart

The examples folder contains example main scripts, which demonstrate usage of the provided modules. The scripts should be executed from within this folder.

Requirements

Mosek or CPLEX. Both Mosek and CPLEX provide free academic versions. If neither MOSEK nor CPLEX are available, it is possible to fall back to MATLAB's built-in linprog and intlinprog, but performance will be compromised.
JPL's Small Body Dynamics Toolkit (SBDT). SBDT is not open-source. A license can be requested from download.jpl.nasa.gov mentioning NTR-49005.
NASA's SPICE MATLAB toolkit (MICE), available at this link.
In order to automatically download SPICE data, the Expect/TCL scripting language should be available. On Debian-based systems, you can sudo apt-get install expect. On MacOS, brew install expect with Homebrew. On Windows, either use the Windows Subsystem for Linux, or manually download SPICE data as discussed below..

Setup

Set the following environment variables:

SBDT_PATH should point to the folder where SBDT is installed.
NAIF_PATH should point to the folder where NAIF data will be stored. This is typically the subfolder utilities/spice inside this repository.

Run the script utilities/spice/download_SPICE_kernel.sh to download required data from NASA's SPICE orbit database. If Expect/TCL is unavailable, manually download the orbit data for 433 EROS from Horizons and save it as ${NAIF_PATH}/naif/generic_kernels/spk/asteroids/a433.bsp.

To set environment variables:

On Linux-based systems, add the line export SBDT_PATH="path/to/your/copy/of/sbdt" and export NAIF_PATH="path/to/your/copy/of/naif" to ~/.bashrc. If you use a different shell (e.g. zsh), add the lines to the appropriate .*rc file.
On MacOS, follow these instructions.

WARNING On MacOS, setting environment variables in ~/.bashrc or ~/.zshrc will not affect MATLAB unless MATLAB is launched from the terminal.
On Windows, follow these instructions.

Apply the patches in utilities/sbdt to the files harmonic_gravity.c and harmonic_gravity_complex_3.cpp in SBDT and recompile the corresponding MEX files.

Modules

small_body_dynamics

Integrators to simulate the orbital dynamics of a spacecraft in orbit around a small body.

network_flow_communication_optimizer

Optimize the communication flows between spacecraft, given a set of orbits, data production, and a communication model.

relay_orbit_optimizer

Optimize the orbit of relay spacecraft, given the orbits of science spacecraft, their data production, and the orbit of the carrier.

observed_points_optimizer

Optimize the observation of spacecraft, given the orbits of science spacecraft.

monte_carlo_coverage_optimizer

Runs a monte carlo to select spacecraft orbits. Calls the observed points optimizer to calculate the coverage reward of each trial orbit set.

utilities

Common utilities and supporting functions for icc simulation and analysis.

media

Various media.

Structure of Optimization Modules

The optimizer modules are composed of a main function (is called outside the module) and several supporting functions which should only be called from within the module. Functions supporting multiple modules are placed in utilities.

Interfaces

The system is defined through two special classes, which serve as the primary interfaces (inputs and outputs) between the modules.

SpacecraftSwarm: Defines the swarm of spacecraft.
SphericalHarmonicsGravityIntegrator_SBDT: Defines the small body that the spacecraft orbit around and integrates trajectories using JPL's Small Body Dynamics Integrator (SBDT).

See the examples directory for usage examples.

Troubleshooting

Troubleshooting SBDT

SBDT is typically distributed as a .zip file. The archive contains tests in the Tests folder and examples in the Demos folder.

Core SBDT functions are implemented in C and must be compiled to MATLAB mex files to enable MATLAB to call them. The SBDT distribution contains pre-compiled MEX files for Windows, MacOS, and Linux inside the folder CompiledMEX. If you encounter issues trying to run SBDT, it may be advisable to recompile the MEX files from scratch. To do this,

Navigate to the SBDT root folder.
In MATLAB, run compileMexSBDT(). A number of files will be generated in the folder. The file extension is mexw64 on Windows, mexa64 on Linux, and mexmaci64 on MacOS.
Copy the newly generated mex files to the CompiledMEX folder, overwriting the previous ones.

Missing function `setstructfields`

SBDT internally makes use of the MATLAB function setstructfields, which is provided by the Signal Processing toolbox. If you do not have access to the Signal Processing toolbox, the repository contains a clean-room reimplementation of the function (based on this description). To use it, rename the file from setstructfields_ICC.m to setstructfields.m and ensure that it is in a folder on your MATLAB PATH.

Warning: P-file is older than M-file

Depending on the SBDT distribution in use, you may receive the warning

Warning: P-file $PATH/TO/FILE.p is older than M-file $PATH/TO/FILE.m.
$PATH/TO/FILE.p may be obsolete and may need to be regenerated.
Type "help pcode" for information about generating P-files from M-files.

You can get rid of this warning by navigating to the SBDT folder in the terminal and running

find . -type f -name "*.p" -exec touch {} +

This will reset the last-modified time of all .p files to the current date and time.

Detailed instructions on how to set environment variables

MacOS

Create a file named environment_variables.plist in ~/Library/LaunchAgents/ (the file name is immaterial, but the extension should be .plist).
Edit the file to contain the following text:

<?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
   <plist version="1.0">
   <dict>
   <key>Label</key>
   <string>Set environment variables that will be picked up by Spotlight</string>
   <key>ProgramArguments</key>
   <array>
     <string>/bin/launchctl</string>
     <string>setenv</string>
     <string>SBDT_PATH</string>
     <string>/Users/frossi/Documents/JPL/ICC/SBDT</string>
     <string>NAIF_PATH</string>
     <string>/Users/frossi/Documents/JPL/ICC/icc-dev/utilities/spice/</string>
   </array>
   <key>RunAtLoad</key>
   <true/>
 </dict>
 </plist>

Ensure that the SBDT and NAIF paths are set to the proper path on your machine.

launchctl load ~/Library/LaunchAgents/environment_variables.plist
launchctl start ~/Library/LaunchAgents/environment_variables.plist

nasa / icc Goto Github PK

icc's Introduction