Skip to content

ARGoPS/NF_ER3BP_Python

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ER3BP Normal Form Code (Python)

This project contains all of the data an functions necessary for transforming between Cartesian ER3BP states, normal form states, and action-angle states for both the Birkhoff and resonant normal forms for libration points L1 and L2.

Installation

To install, simply download this repository, extract it, and then copy the "NF_ER3BP" folder into your desired working directory.
The normal form functions can then be loaded in by including the following line in any of your python scripts.

from NF_ER3BP.NF_ER3BP import *

or import NF_ER3BP.NF_ER3BP as er3bp if you would like to work with both the CR3BP toolbox and this toolbox simultaneously.

This code is designed to run "out of the box", and has been verified to work on MATLAB versions 2022b and later.

To install, simply download this repository and extract it to wherever you'd like.

To access the NF_CR3BP functions from other folders, right click on the "NF_ER3BP_MATLAB" folder while in MATLAB and select "Add to path > Selected folders" or use the pathtool to add it to path permanently.

Capabilities

  1. One system (for now)
    • Earth-Moon
  2. Two normal forms
    • Birkhoff
    • Resonant
  3. Two libration points
    • $L_1$
    • $L_2$

All normal form approximations are of degree 10, with Fourier coefficients truncated at magnitudes below 1e-12.

Getting Started

Tutorial.ipybn has been included to provide an introduction to all of the functions included in this project.
It is highly recommended to read through the comments and try running and fiddling with the examples.

For a higher-level view of the functionality offered, refer to the following diagram.

Structure of normal form code

The documentation for the Python toolbox is admittedly quite poor (I'll work on this eventually). If you are running into issues or have questions about a particular function, it is best to hop over to the corresponding file in the MATLAB toolbox, where some nice comments have been provided.

Important Note

It is recommended that you first familiarize yourself with the CR3BP toolbox, since the two have much in common. The ER3BP transformations take quite a bit longer, meaning that learning how to use this toolbox from scratch will be a bit more tedious.

About

Public ER3BP normal form Python code

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors