halo_module Module

ephemeris time reference epoch (all times relative to this)

initial time [days]

opt var scale for t0

opt var dpert for t0 [scaled]

initial state [km, km/s], rotating frame

opt var scale for x0_rotating

opt var dperts for x0_rotating [scaled]

initial state [km, km/s], inertial frame

final time [days]

final state [km, km/s], inertial frame

final state [km, km/s], rotating frame

func scale for xf_rotating

the segment name

used when computing gradients

central body geopotential model [global]

the ephemeris [global]

in the inertial frame (j2000-moon)

in the rotating frame (moon-earth, moon-centered)

in the rotating frame (sun-earth, earth-centered)

to read the initial guess from a JSOn file

if true, the ephemeris is splined

time step in seconds for spline step [1 hr]

if true, the central body is a pointmass (moon). otherwise, the grav model is used.

central body geopotential model [global]

the ephemeris [global]

the list of segments

opt var scale factors

opt var dpert factors [rename because already in base class]

function scale factors

opt var names

'N' or 'S'

'L1' or 'L2'

run the nle solver to solve the problem

to generate the python plots

to export the txt trajectory files.

to export the JSON trajectory file for the solution (contains inertial and rotating data). This one is used by the PyVista python script for plotting

to export the json guess and solution files.

to generate a spice kernel (bsp) of the solution [this requires the external mkspk SPICE tool]

generate the file that shows the pos/vel constraint defects for the solution

generate the eclipse data file for the solution

run the pyvista script to generate the interacdtive 3d plot

radius of the "eclipse bubble" [km]

dense time step output for eclipse calculations in sec [1 hour]

type of eclipse file: 1=csv or 2=json

1 - calendar date was specified, 2 - ephemeris time was specified

epoch of first point (first periapsis crossing)

epoch of first point (first periapsis crossing)

epoch of first point (first periapsis crossing)

epoch of first point (first periapsis crossing)

epoch of first point (first periapsis crossing)

epoch of first point (first periapsis crossing)

ephemeris time reference epoch [sec] (all times relative to this). this is computed from the year,month,day,hour,minute,sec values if epoch_mode=1

Number of revs in the Halo.

integrator rtol

integrator atol

nlesolver tol

if fix_initial_r is True, this can be used to specify the initial r (moon-centered earth-moon rotating frame)

the JPL ephemeris file to load

spherical harmonic gravity coeff file (Moon) example: 'data/grav/gggrx_0020pm_sha.tab'

Halo CR3BP patch point solution file example: 'data/L2_halos.json'

if the state in the patch point file are periapsis states (false means they are apoapsis states. the ones in L2_halos.json are apoapsis states)

Patchpoint Periapse State

Patchpoint 1/4 Rev State

Patchpoint 1/2 Rev State

Halo period [days]

1/8 of Halo period [days]

to fix the initial epoch in the mission

fix the initial periapsis position vector (x,y,z)

fix ry at the end of the specified rev (at periapsis) not used if <= 0.

fix ry and vx at the end of the last rev (at periapsis)

use sparse or dense solver:

the Halo mission

the config file to read

for debugging prints

number of opt vars for the solver

number of equality constraints for the solver

number of segments

number of nonzero elements in the Jacobian

if true (default) always return the results for the full problem (i.e., without fixing any of the variables)

the config file to read

initial guess

n: number of columns in A.

m: number of rows in A.

number of nonzero elements of A.

sparsity pattern (size is n_nonzero)

sparsity pattern (size is n_nonzero)

matrix elements (size is n_nonzero)

right hand side (size is m)

solution (size is n)

status code (=0 for success)

opt var vector [scaled]

constraint violations

csv file to write to

scaled x vector

opt var vector (scaled)

sparsity pattern nonzero elements row indices

sparsity pattern nonzero elements column indices

linear sparsity pattern nonzero elements row indices

linear sparsity pattern nonzero elements column indices

linear sparsity values (constant elements of the Jacobian)

DSM sparsity partition

DSM sparsity partition

initial guess

time [sec from epoch]

state [r,v] in inertial frame (moon-centered)

derivative of state ($dx/dt$)

[days]

[days]

state in rotating frame

rotating frame

inertial frame

rotating frame

inertial frame

inertial frame

1 - don't report steps, 2 - report steps (for plotting)

fixed time step for mode=2

the indices of f to compute

segment numbers

opt var vector for the mission [n]

constraint violation vector for the mission [m]

the indices of f to compute

the columns being computed.

perturbing these columns for the ith time (1,2,...)

the nominal variable vector

the function indices to compute in the full f vector

iteration number

plot file name [without extension]

if true, a text trajectory file is also produced (that can be read by MKSPK) [default is False]

if true [Default], a matplotlib plot is generated

to only do the first rev [Default is False]

plot file name [without extension]

to only do the first rev [Default is False]

file prefix for the csv file (case name will be added)

type of output file: 1=csv [default] or 2=json

the trajectory

time from integrator (sec from sim epoch)

state [moon-centered inertial frame]

1 : calendar date was specified, 2: ephemeris time was specified

only output if found (epoch_mode=1)

only output if found (epoch_mode=1)

only output if found (epoch_mode=1)

only output if found (epoch_mode=1)

only output if found (epoch_mode=1)

only output if found (epoch_mode=1)

the ephemeris time [always output]

the JSON config file to read

periapsis, quarter, apoapsis patch points

file name [without extension]

solver opt vars vector