Skip to content

Commit

Permalink
Add publication link to Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
henrystoldt committed Dec 11, 2021
1 parent f1688de commit 8248aae
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@


<p align="center">
<img src="https://raw.githubusercontent.com/henrystoldt/MAPLEAF/master/Resources/Draft2Logo.png" alt="Logo"
title="MAPLEAF" height=150 style="padding-right: 10px;"/>
Expand All @@ -26,7 +24,7 @@ Prerequisites:

`$ pip install MAPLEAF`

The (optional) dependencies used to enable 3D flight path renders (mayavi) and parallelization (ray) are not installed by default because they're often tricky to get running. Run the installOptionalPackages.py script to try installing them if you want to use those capabilities. See ray and mayavi github pages/documentation for help getting them installed.
The (optional) dependencies used to enable 3D flight path renders (mayavi) and parallelization (ray) are not installed by default because they're often tricky to get running. Run the [installOptionalPackages.py](https://github.com/henrystoldt/MAPLEAF/blob/master/installOptionalPackages.py) script to try installing them if you want to use those capabilities. See ray and mayavi github pages/documentation for more help getting them installed.

### Test your installation
Unit tests:
Expand Down Expand Up @@ -148,4 +146,8 @@ To run the regression/verification/validation test suite, check out [README_Dev.
To run **Monte Carlo** or **Optimization** simulations in parallel:
`mapleaf --parallel MonteCarlo.mapleaf`

MAPLEAF's parallelization is implemented using [ray](https://github.com/ray-project/ray).
MAPLEAF's parallelization is implemented using [ray](https://github.com/ray-project/ray).

## Cite MAPLEAF
[Stoldt, H., Quinn, D., Kavanagh, J., Johansen, C. (2021). MAPLEAF: A Compact, Extensible, Open-Source, 6-
Degrees-of-Freedom Rocket Flight Simulation Framework. In 2021 AIAA Propulsion & Energy Forum.](https://arc.aiaa.org/doi/abs/10.2514/6.2021-3267)

0 comments on commit 8248aae

Please sign in to comment.