Skip to main content

A compact, extensible rocket flight simulation framework for researchers and rocket designers

Project description

Logo

Modular Aerospace Prediction Lab for Engines and Aero Forces

Tests Linting Docs Coverage Python3 MIT License

Install:

Prerequisites:

$ pip install MAPLEAF

Running a Simulation

$ mapleaf path/to/SimDefinitionFile.mapleaf

Sample simulation definitions: MAPLEAF/Examples/Simulations
Example cases be run with just the case name: $ mapleaf NASATwoStageOrbitalRocket
This is the same as running: $ mapleaf MAPLEAF/Examples/Simulations/NASATwoStageOrbitalRocket.mapleaf from MAPLEAF's install location

Help: $ mapleaf -h

Simulation Definition Files

Brief overview below. More info, and definitions of all possible options in: SimDefinitionTemplate.mapleaf

Format is a simple key-value syntax similar to JSON or YAML.
Dictionaries can be nested arbitrarily deeply and are brace-delimited.
Keys and values in a dictionary are separated by the first whitespace in their line
No multiline values

Example:

SimControl{
  timeDiscretization    RK45Adaptive

  TimeStepAdaptation{
    controller          PID
    PID.coefficients    -0.01 -0.001 0
    targetError         0.0001
  }
}

Code folding and syntax highlighting are helpful in maintaining a file overview:

Folded Sim Definition

The possible top level dictionaries are 'Optimization', 'MonteCarlo', 'SimControl', 'Environment', and 'Rocket'. Of these, only the 'Rocket' dictionary is strictly required to run a simulation, and defines the rocket's initial position/velocity and the inertial/aerodynamic/control models used to simulate it.
The rocket is defined by nested subdictionaries, where the first level of nesting defines the rocket's stage(s) and the second level defines the component(s) in each stage:

Rocket Definition

Default values from the defaultConfigValues dictionary in MAPLEAF/IO/SimDefinition.py will fill in for omitted keys. Most defaults match the values in SimDefinitionTemplate.mapleaf.

Simulation Outputs

Depending on the options specified in the SimControl dictionary, MAPLEAF will output:

  • Detailed tabulated simulation position, component force, aerodynamic coefficient and control logs (see SimControl.loggingLevel): Sample section of log file

  • Flight animations (see SimControl.plot)
    Flight Animation

  • Flight path visualizations (see SimControl.plot - Mayavi is required to render these ones showing the Earth)
    Earth Orbit

  • Plots of any logged parameter (see SimControl.plot or --plotFromLog command line option)
    Plotting from logs

Monte Carlo Simulations

Monte Carlo simulations propagate uncertainties in simulation inputs through to simulation outputs.
Any scalar or vector parameter in simulation definition files can be made probabilistic by adding a second parameter with _stdDev appended to the name:

Monte Carlo Parameter

To execute a batch run of this now-probabilistic simulation, create the top-level 'Monte Carlo' dictionary (see SimDefinitionTemplate.mapleaf)

Then, MAPLEAF can produce distributions of outputs like landing locations:
Landing Location Plot

Design Optimization

MAPLEAF uses pyswarms to optimize arbitrary scalar parameters according to arbitrary cost functions using Particle Swarm Optimization. To define an optimization problem, include the top-level 'Optimization' dictionary (see SimDefinitionTemplate.mapleaf):

Optimization Dict

Pyswarms will produce a plot of the optimization results after completion:

Optimization Result

Batch Simulations

Automates running and post-processing groups of cases.
To run: $ mapleaf-batch path/to/batchDefinitionFile
For help: $ mapleaf-batch -h

Batch Definition

Provides ability to automate production of detailed plots of MAPLEAF's results compared to verification/validation data, and to run Wind-Tunnel style aero-sweep simulations:

Canted Fin Roll Rate

Wind Tunnel Comparison

Used for regression and verification/validation testing in MAPLEAF.
See batchRunTemplate.mapleaf for complete batch interface definition and regressionTests.mapleaf for examples.

To run the regression/verification/validation test suite, check out README_Dev.md

Parallelization

To run Monte Carlo or Optimization simulations in parallel: mapleaf --nCores 8 MonteCarlo.mapleaf

MAPLEAF's parallelization is implemented using ray.

Developers

Contributions are welcome. To learn about the code, have a look at README_Dev.md, and the code/api documentation website

Project details


Download files

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

Files for MAPLEAF, version 0.8.11
Filename, size File type Python version Upload date Hashes
Filename, size MAPLEAF-0.8.11.tar.gz (24.0 MB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page