Create Getting to know SEMpy authored by GARY Yvan's avatar GARY Yvan
# 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 access the documentation index, get into docs/index and open index.html
Open the file with your favorite browser (Chrome or Chromium recommended).
### 2.2 Examples of SEMpy's applications
You will also the find an example folder, containing applications of some of SEMpy's modules.
Note : The Visualisation and Optimal Control modules being optionnal, you won't be able to run them if you only installed SEMpy Core.
\ No newline at end of file