Merge pull request #15 from Oxyde2/master

v0.6.0
RimorRes · Feb 16, 2020 · 662e086 · 662e086
2 parents bdd3a6a + 718ee1b
commit 662e086
Show file tree

Hide file tree

Showing 19 changed files with 1,486 additions and 203 deletions.
diff --git a/.coverage b/.coverage
@@ -1 +1 @@
-!coverage.py: This is a private format, don't read it directly!{"lines":{"C:\\Users\\maxim\\Documents\\Preflight\\preflight\\__init__.py":[1,2,3],"C:\\Users\\maxim\\Documents\\Preflight\\preflight\\env.py":[3,4,6,14,17,33,40,46,49,8,9,10,11,12,50,15,51,52,18,19,53,54,34,35,55,56,41,42,43,44,57,47,20,21,37,22,24,26,28,29,23,27,30,31,25],"C:\\Users\\maxim\\Documents\\Preflight\\preflight\\system.py":[3,4,5,7,8,41,140,145,149,154,159,163,166,171,174,178,182,198,210],"C:\\Users\\maxim\\Documents\\Preflight\\preflight\\params.py":[3,4,6,36,8,9,11,13,27,28,30,31,37,38,39,40,33,34,14,16,18,23,24,19,20]}}
+!coverage.py: This is a private format, don't read it directly!{"lines":{"C:\\Users\\maxim\\Documents\\Preflight\\preflightpy\\__init__.py":[1,2,3],"C:\\Users\\maxim\\Documents\\Preflight\\preflightpy\\env.py":[20,22,23,25,33,36,77,109,116,119,27,28,29,30,31,120,34,121,37,38,122,79,83,84,85,123,110,111,112,113,114,124,117,39,40,87,41,43,45,47,48,49,51,52,88,89,80,81,53,54,55,58,90,91,56,57,92,93,59,60,94,95,61,62,63,74,75,96,97,64,65,98,99,66,67,100,101,68,69,102,103,70,71,104,105,72,73,106,107,42,44],"C:\\Users\\maxim\\Documents\\Preflight\\preflightpy\\system.py":[20,22,23,24,26,27,60,159,164,168,173,178,182,185,190,193,197,201,217,229],"C:\\Users\\maxim\\Documents\\Preflight\\preflightpy\\params.py":[20,22,23,25,55,56,57,58,59,27,28,30,32,33,35,37,42,43,38,39,52,53,46,47,49,50]}}
diff --git a/.gitignore b/.gitignore
@@ -16,3 +16,8 @@ preflight-env/
 
 # Ignore pycharm folder
 .idea/
+
+#Ignore build
+build/
+dist/
+preflightpy.egg-info/
diff --git a/.travis.yml b/.travis.yml
@@ -2,11 +2,14 @@ language: python
 python:
   - "3.6"      # current default Python on Travis CI
   - "3.7"
+  - "3.8"
 # command to install dependencies
 install:
   - pip install -r REQUIREMENTS.txt
 # command to run tests
 script:
-  - pytest -v --cov=preflight
+  - pytest -v --cov=preflightpy
+  - flake8 preflightpy
+  - flake8 tests
 after_success:
   - coveralls
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,7 +4,15 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to semantic versioning: [SemVer](https://semver.org/).
 
-## [Unreleased]
+## [0.6.0] - 2019-11-2
+### Added
+- Unit tests for heterosphere model
+- Unit tests for `params.py`
+
+### Changed
+- `env.py` for 86km - 1000km support
+
+## [0.5.0] - 2019-11-1
 ### Added
 - `env.py` for the `Environment` class
 - `case.json` for input

diff --git a/LICENSE b/LICENSE
diff --git a/LICENSE.md b/LICENSE.md
diff --git a/README.md b/README.md
@@ -1,9 +1,14 @@
 # PreFlight
 
+[![PyPI](https://img.shields.io/pypi/v/preflightpy?color=blue)](https://pypi.org/project/preflightpy/)
+[![GitHub](https://img.shields.io/github/license/Oxyde2/Preflight?color=yellow)](LICENSE)
+
 [![Coverage Status](https://coveralls.io/repos/github/Oxyde2/Preflight/badge.svg?branch=master)](https://coveralls.io/github/Oxyde2/Preflight?branch=master)
 [![Build Status](https://travis-ci.com/Oxyde2/Preflight.svg?branch=master)](https://travis-ci.com/Oxyde2/Preflight)
 
-Python module for rocket flight simulation.
+[![Gitmoji](https://img.shields.io/badge/gitmoji-%20%F0%9F%98%9C%20%F0%9F%98%8D-FFDD67.svg?)](https://gitmoji.carloscuesta.me/)
+
+Python module for **S**imulation and **O**ptimization of **R**ocket **T**rajectories, [**SORT**](https://www.nasa.gov/pdf/140648main_ESAS_17a.pdf) for short.
 - Altitude prediction
 - State prediction
 - Flight trajectory optimization
@@ -13,17 +18,15 @@ Python module for rocket flight simulation.
 
 These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
 
-### Prerequisites
 
-- Python3.x for running the `.py` files.
+## Installation
 
-To install the required python modules just run the following command in the command line.
+You can get Preflight from pip via `pip install preflight`. To contribute
+to the package, check out our [contribution guidelines](CONTRIBUTING.md) and preform the following steps.
 
-```
-pip install -r requirements.txt
-```
+### Contribuitng
 
-### Installing
+#### Cloning
 
  1. Cloning
     Through the command line, get to the directory you wish to clone the repository into then run the following command.
@@ -34,31 +37,18 @@ pip install -r requirements.txt
 2. Downloading the ZIP
     Download the compressed files and unzip them.
 
-Once you have successfully obtained your local copy open the project folder in your desired IDE or text editor.
-
-Great! You're all set now!
+#### Prerequisites
 
-### Launch the program!
+To install the required python modules just run the following command in the command line at the root of the repository.
 
-1. Running the `.exe` file **Unvailable in versions inferior to 0.5.0**
-
-    - Navigate through the command-line:
-      ```bash
-      cd dist/PreFlight
-      ./PreFlight.exe
-      ```
-    - Or find the file through the file explorer.
-
-2. Running the `.py` file **Unavailable in version 0.5.0-alpha.1**
+```
+pip install -r requirements.txt
+```
 
-    **You need to have Python3.x installed and have it's paths in the PATH environmental variable**
+Once you have successfully obtained your local copy and the dependencies, open the project folder in your desired IDE or text editor.
 
-    - Navigate from the PreFlight folder:
-      ```bash
-      cd dist/PreFlight
-      python PreFlight.py
-      ```
-    - Or find the file through the file explorer.
+**PreFlight requires Python 3.6+ and is not compatible with
+Python 2.x.**
 
 ## Built With
 
@@ -78,8 +68,9 @@ For available versions, see the [releases of this project](https://github.com/Ox
 
 ## License
 
-This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
+This project is licensed under the GNU General Public License v3.0 - see the [LICENSE.md](LICENSE.md) file for details
 
 ## Acknowledgments
 
-* [Mix_42](https://github.com/42mix)
+Early development of Preflight was supported by [Mix_42](https://github.com/42mix).
+The website [Rocket & Space Technology](http://www.braeunig.us/space/), written by Robert A. Braeunig, was used for pressure, density and temperature formulas for the atmospheric model.
diff --git a/REQUIREMENTS.txt b/REQUIREMENTS.txt
@@ -1,4 +1,5 @@
 matplotlib
+coverage
 pytest
 pytest-cov
 flake8

diff --git a/preflight/__init__.py b/preflight/__init__.py
diff --git a/preflight/env.py b/preflight/env.py
diff --git a/preflight/params.py b/preflight/params.py
diff --git a/preflightpy/__init__.py b/preflightpy/__init__.py
@@ -0,0 +1,4 @@
+# flake8: noqa
+from preflightpy.env import Environment
+from preflightpy.system import System
+from preflightpy.params import Parameters