Merge branch 'master' into bug/mixed-calendars

Author: Lucas-KB

.travis.yml

@@ -0,0 +1,11 @@
+language: python
+python:
+  - "3.8"
+install:
+  - make install
+  - pip install -r requirements_test.txt
+
+before_script:
+  - make verify-lint
+script:
+  - make test

Makefile

@@ -0,0 +1,21 @@
+test:
+	pytest tests -vv
+
+tests: 
+	test
+
+coverage: 
+	pytest --cov=rocketpy tests -vv
+
+install: 
+	python -m pip install --upgrade pip
+	pip install -r requirements.txt
+	python setup.py install
+
+verify-lint:
+	flake8 --select BLK rocketpy
+	flake8 --select BLK test
+
+lint:
+	black rocketpy
+	black tests

README.md

@@ -7,6 +7,34 @@
 # RocketPy
 RocketPy is a trajectory simulation for High-Power Rocketry built by [Projeto Jupiter](https://www.facebook.com/ProjetoJupiter/). The code is written as a [Python](http://www.python.org) library and allows for a complete 6 degrees of freedom simulation of a rocket's flight trajectory, including high fidelity variable mass effects as well as descent under parachutes. Weather conditions, such as wind profile, can be imported from sophisticated datasets, allowing for realistic scenarios. Furthermore, the implementation facilitates complex simulations, such as multi-stage rockets, design and trajectory optimization and dispersion analysis.
 
+## Main features
+
+- Nonlinear 6 degrees of freedom simulations
+  - Solved using LSODA with adjustable error tolerances
+  - Highly optimized to run fast
+- Rigorous treatment of mass variation effects
+- Aerodynamic models:
+  - Barrowman equations for lift coefficients (optional)
+  - Drag coefficients can be easily imported from other sources (e.g. CFD simulations)
+- Parachutes with external trigger functions
+  - Test the exact code that will fly
+  - Sensor data can be augmented with noise
+- Solid motors models:
+  - Burn rate and mass variation properties from thrust curve
+- Accurate weather modeling
+  - International Standard Atmosphere (1976)
+  - Custom atmospheric profiles
+  - Soundings (Wyoming, NOAARuc)
+  - Weather forecasts and reanalysis
+  - Weather ensembles
+- Monte Carlo simulations for dispersion and sensitivity analysis
+- Flexible and modular
+  - Straightforward engineering analysis (e.g. apogee and lifting off speed as a function of mass)
+  - Non-standard flights (e.g. parachute drop test from helicopter)
+  - Multi-stage rockets
+  - Custom continuous and discrete control laws
+  - Create new classes (e.g. other types of motors)
+
 ## Join Our Community!
 RocketPy is growing fast! Many unviersity groups and rocket hobbyist have already started using it. The number of stars and forks for this repository is skyrocketing. And this is all thanks to a great community of users, engineers, developers, marketing specialists, and everyone interested in helping.
 

docs/conf.py

@@ -67,3 +67,26 @@
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
+html_logo = "static/RocketPy_Logo_Black.svg"
+html_theme_options = {
+    "icon_links": [
+        {
+            "name": "GitHub",
+            "url": "https://github.com/Projeto-Jupiter/RocketPy",
+            "icon": "fab fa-github-square",
+        },
+        {
+            "name": "LinkedIn",
+            "url": "https://www.linkedin.com/company/rocketpy/",
+            "icon": "fab fa-linkedin",
+        },
+    ],
+}
+
+html_sidebars = {
+    "**": ["search-field.html", "sidebar-nav-bs.html", "sidebar-ethical-ads.html"]
+}
+html_theme_options = {
+    "navbar_end": ["navbar-icon-links.html", "search-field.html"]
+}
+

docs/static/RocketPy_Logo_Black.svg

@@ -0,0 +1,4 @@
+pytest==6.2.4
+pytest-coverage
+black
+flake8-black

requirements_test.txt

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-__author__ = "Giovani Hidalgo Ceotto"
+__author__ = "Giovani Hidalgo Ceotto, João Lemes Gribel Soares"
 __copyright__ = "Copyright 20XX, Projeto Jupiter"
 __license__ = "MIT"
 
@@ -85,7 +85,7 @@ class Flight:
             calculate them and feed the triggers. Can greatly improve run
             time in some cases.
         Flight.terminateOnApogee : bool
-            Wheater to terminate simulation when rocket reaches apogee.
+            Whether to terminate simulation when rocket reaches apogee.
         Flight.solver : scipy.integrate.LSODA
             Scipy LSODA integration scheme.
 
@@ -336,23 +336,23 @@ class Flight:
             Direction 3 is in the rocket's body axis and points in the
             direction of cylindrical symmetry.
         Flight.M1 : Function
-            Resultant momentum perpendicular to rockets axis due to
+            Resultant moment (torque) perpendicular to rockets axis due to
             aerodynamic forces and excentricity as a function of time.
             Units in N*m.
             Expressed as a function of time. Can be called or accessed
             as array.
             Direction 1 is in the rocket's body axis and points perpendicular
             to the rocket's axis of cylindrical symmetry.
         Flight.M2 : Function
-            Resultant momentum perpendicular to rockets axis due to
+            Resultant moment (torque) perpendicular to rockets axis due to
             aerodynamic forces and excentricity as a function of time.
             Units in N*m.
             Expressed as a function of time. Can be called or accessed
             as array.
             Direction 2 is in the rocket's body axis and points perpendicular
             to the rocket's axis of cylindrical symmetry and direction 1.
         Flight.M3 : Function
-            Resultant momentum in rockets axis due to aerodynamic
+            Resultant moment (torque) in rockets axis due to aerodynamic
             forces and excentricity as a function of time. Units in N*m.
             Expressed as a function of time. Can be called or accessed
             as array.
@@ -461,15 +461,15 @@ class Flight:
         Flight.apogeeFreestreamSpeed : float
             Freestream speed of the rocket at apogee in m/s.
         Flight.MachNumber : Function
-            Rocket's Mach number defined as it's freestream speed
+            Rocket's Mach number defined as its freestream speed
             devided by the speed of sound at its altitude. Expressed
             as a function of time. Can be called or accessed as array.
         Flight.maxMachNumber : float
             Rocket's maximum Mach number experienced during flight.
         Flight.maxMachNumberTime : float
             Time at which the rocket experiences the maximum Mach number.
         Flight.ReynoldsNumber : Function
-            Rocket's Reynolds number, using it's diameter as reference
+            Rocket's Reynolds number, using its diameter as reference
             length and freestreamSpeed as reference velocity. Expressed
             as a function of time. Can be called or accessed as array.
         Flight.maxReynoldsNumber : float
@@ -550,7 +550,7 @@ def __init__(
             except for the euler parameters which will be calculated based
             on given values of inclination and heading. Default is None.
         terminateOnApogee : boolean, optioanal
-            Wheater to terminate simulation when rocket reaches apogee.
+            Whether to terminate simulation when rocket reaches apogee.
             Default is False.
         maxTime : int, float, optional
             Maximum time in which to simulate trajectory in seconds.
@@ -688,7 +688,7 @@ def __init__(
             headingRad
         )
 
-        # Create knonw flight phases
+        # Create known flight phases
         self.flightPhases = FlightPhases()
         self.flightPhases.addPhase(self.tInitial, self.initialDerivative, clear=False)
         self.flightPhases.addPhase(self.maxTime)
@@ -922,7 +922,7 @@ def __init__(
                         vz1 = self.solution[-1][6]
                         t1 = self.solution[-1][0]
                         t_root = -(t1 - t0) * vz0 / (vz1 - vz0) + t0
-                        # Fecth state at t_root
+                        # Fetch state at t_root
                         interpolator = phase.solver.dense_output()
                         self.apogeeState = interpolator(t_root)
                         # Store apogee data
@@ -1552,7 +1552,7 @@ def postProcess(self):
         self.ax, self.ay, self.az = [], [], []
         self.alpha1, self.alpha2, self.alpha3 = [], [], []
         # Go throught each time step and calculate accelerations
-        # Get fligth phases
+        # Get flight phases
         for phase_index, phase in self.timeIterator(self.flightPhases):
             initTime = phase.t
             finalTime = self.flightPhases[phase_index + 1].t
@@ -1594,7 +1594,7 @@ def postProcess(self):
         )
         self.windVelocityX, self.windVelocityY = [], []
         # Go throught each time step and calculate forces and atmospheric values
-        # Get fligth phases
+        # Get flight phases
         for phase_index, phase in self.timeIterator(self.flightPhases):
             initTime = phase.t
             finalTime = self.flightPhases[phase_index + 1].t
@@ -1631,7 +1631,7 @@ def postProcess(self):
 
         # Process fourth type of output - values calculated from previous outputs
 
-        # Kinematicss functions and values
+        # Kinematics functions and values
         # Velocity Magnitude
         self.speed = (self.vx ** 2 + self.vy ** 2 + self.vz ** 2) ** 0.5
         self.speed.setOutputs("Speed - Velocity Magnitude (m/s)")
@@ -2036,7 +2036,7 @@ def info(self):
         print("Frontal Surface Wind Speed: {:.2f} m/s".format(self.frontalSurfaceWind))
         print("Lateral Surface Wind Speed: {:.2f} m/s".format(self.lateralSurfaceWind))
 
-        # Print of rail conditions
+        # Print out of rail conditions
         print("\n\n Rail Departure State\n")
         print("Rail Departure Time: {:.3f} s".format(self.outOfRailTime))
         print("Rail Departure Velocity: {:.3f} m/s".format(self.outOfRailVelocity))
@@ -2573,7 +2573,7 @@ def plotFlightPathAngleData(self):
         return None
 
     def plotAngularKinematicsData(self):
-        """Prints out all Angular veolcity and acceleration graphs available
+        """Prints out all Angular velocity and acceleration graphs available
         about the Flight
 
         Parameters
@@ -3190,7 +3190,7 @@ def plotPressureSignals(self):
         has not been added.
 
         This function aims to help the engineer to visually check if there
-        isn't no anomalies with the Flight Simulation.
+        are anomalies with the Flight Simulation.
 
         Parameters
         ----------

rocketpy/Flight.py

@@ -1336,7 +1336,7 @@ def comparePlots(
 
     # Define all interpolation methods
     def __interpolatePolynomial__(self):
-        """"Calculate polynomail coefficients that fit the data exactly."""
+        """Calculate polynomail coefficients that fit the data exactly."""
         # Find the degree of the polynomial interpolation
         degree = self.source.shape[0] - 1
         # Get x and y values for all supplied points.