|
|
# SEMpy: Documentation and Examples
|
|
|
|
|
|
@author: Yvan GARY
|
|
|
|
|
|
## Introduction
|
|
|
|
|
|
To help you getting started with SEMpy, we created a Starting Pack containing SEMpy's documentation and some examples of applications of the library.
|
|
|
|
|
|
# 1. Getting SEMpy Starting Pack
|
|
|
|
|
|
Once you have downloaded the library, you should have a sempy folder containing SEMpy's recipe.
|
|
|
You can install the Starting Pack here, but it is of course not mandatory.
|
|
|
|
|
|
Go to your home directory, and then to the sempy folder:
|
|
|
|
|
|
```bash
|
|
|
cd sempy
|
|
|
```
|
|
|
|
|
|
Once there, clone the associated distant repository:
|
|
|
|
|
|
```bash
|
|
|
git clone https://gitlab.isae-supaero.fr/sempy/sempy-starting-pack.git
|
|
|
```
|
|
|
|
|
|
Now you should have a sempy-starting-pack folder inside the sempy folder.
|
|
|
|
|
|
# 2. Content of the Starting Pack
|
|
|
|
|
|
Get into the Starting Pack:
|
|
|
|
|
|
```bash
|
|
|
cd sempy-starting-pack
|
|
|
```
|
|
|
|
|
|
### 2.1 SEMpy's documentation
|
|
|
|
|
|
You should now find a docs folder inside, containing all the information about the documentation.
|
|
|
To get
|
|
|
|
|
|
SEMpy is an open source library (AGPLv3).
|
|
|
|
|
|
### 1.2 SEMpy is dedicated to non-Keplerian environments
|
|
|
|
|
|
SEMpy focuses on non keplerian space mechanics. For Keplerian orbital mechanics in python, please refer to
|
|
|
[Poliastro](https://pypi.org/project/poliastro/), built uppon
|
|
|
[Astropy](https://www.astropy.org) ,more astronomy oriented.
|
|
|
For other pograming languages, have a look at [GMAT](https://opensource.gsfc.nasa.gov/projects/GMAT/index.php) (C++) or [Orekit](https://www.orekit.org)(Java and its python wrapper).
|
|
|
But for non-Keplerian mechanics, we have chosen python 3 to build a state of the art library.
|
|
|
|
|
|
### 1.3 SEMpy is following standards and includes a development framework
|
|
|
|
|
|
If you respect the established standards, it will ease teamwork, development efficiency and sustainability. The framework presented below aims at easing the development process for the SEMpy development team.
|
|
|
|
|
|
## 2. Getting started
|
|
|
|
|
|
### 2.1 Dependencies for SEMpy developers
|
|
|
|
|
|
#### 2.1.1 Python 3
|
|
|
|
|
|
SEMpy is based on Python 3. We recommend the use of Anaconda (3.7) distribution, which includes most of the required libraries and tools used for SEMpy.
|
|
|
|
|
|
https://www.anaconda.com/distribution/
|
|
|
|
|
|
#### 2.1.2 Git client |
|
|
\ No newline at end of file |