rocketpy 1.3.0__1-py3-none-any.whl

rocketpy-1.3.0.dist-info/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Giovani Hidalgo Ceotto
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

rocketpy-1.3.0.dist-info/METADATA

@@ -0,0 +1,403 @@
+Metadata-Version: 2.1
+Name: rocketpy
+Version: 1.3.0
+Summary: Advanced 6-DOF trajectory simulation for High-Power Rocketry.
+Author-email: Giovani Hidalgo Ceotto <ghceotto@gmail.com>
+Project-URL: homepage, https://rocketpy.org/
+Project-URL: documentation, https://docs.rocketpy.org/
+Project-URL: repository, https://github.com/RocketPy-Team/RocketPy
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy >=1.13
+Requires-Dist: scipy >=1.0
+Requires-Dist: matplotlib >=3.0
+Requires-Dist: netCDF4 >=1.6.4
+Requires-Dist: requests
+Requires-Dist: pytz
+Requires-Dist: simplekml
+Provides-Extra: all
+Requires-Dist: rocketpy[env-analysis] ; extra == 'all'
+Requires-Dist: rocketpy[monte-carlo] ; extra == 'all'
+Provides-Extra: env-analysis
+Requires-Dist: windrose >=1.6.8 ; extra == 'env-analysis'
+Requires-Dist: timezonefinder ; extra == 'env-analysis'
+Requires-Dist: jsonpickle ; extra == 'env-analysis'
+Requires-Dist: ipython ; extra == 'env-analysis'
+Requires-Dist: ipywidgets >=7.6.3 ; extra == 'env-analysis'
+Provides-Extra: monte-carlo
+Requires-Dist: imageio ; extra == 'monte-carlo'
+Provides-Extra: tests
+Requires-Dist: pytest ; extra == 'tests'
+Requires-Dist: pytest-coverage ; extra == 'tests'
+Requires-Dist: black[jupyter] ; extra == 'tests'
+Requires-Dist: flake8-black ; extra == 'tests'
+Requires-Dist: flake8-pyproject ; extra == 'tests'
+Requires-Dist: pandas ; extra == 'tests'
+Requires-Dist: numericalunits ==1.25 ; extra == 'tests'
+Requires-Dist: pylint ; extra == 'tests'
+Requires-Dist: isort ; extra == 'tests'
+
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/RocketPy-Team/RocketPy/master/docs/static/RocketPy_Logo_white.png">
+  <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/RocketPy-Team/RocketPy/master/docs/static/RocketPy_Logo_black.png">
+  <img alt="RocketPy Logo" src="https://raw.githubusercontent.com/RocketPy-Team/RocketPy/master/docs/static/RocketPy_Logo_black.png">
+</picture>
+
+<br>
+
+[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/RocketPy-Team/rocketpy/blob/master/docs/notebooks/getting_started_colab.ipynb)
+[![PyPI](https://img.shields.io/pypi/v/rocketpy?color=g)](https://pypi.org/project/rocketpy/)
+[![Documentation Status](https://readthedocs.org/projects/rocketpyalpha/badge/?version=latest)](https://docs.rocketpy.org/en/latest/?badge=latest)
+[![codecov](https://codecov.io/gh/RocketPy-Team/RocketPy/graph/badge.svg?token=Ecc3bsHFeP)](https://codecov.io/gh/RocketPy-Team/RocketPy)
+[![Contributors](https://img.shields.io/github/contributors/RocketPy-Team/rocketpy)](https://github.com/RocketPy-Team/RocketPy/graphs/contributors)
+[![Chat on Discord](https://img.shields.io/discord/765037887016140840?logo=discord)](https://discord.gg/b6xYnNh)
+[![Sponsor RocketPy](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86)](https://github.com/sponsors/RocketPy-Team)
+[![Instagram](https://img.shields.io/badge/Instagram-E4405F?style=flat&logo=instagram&logoColor=white)](https://www.instagram.com/rocketpyteam)
+[![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=flat&logo=linkedin&logoColor=white)](https://www.linkedin.com/company/rocketpy)
+[![DOI](https://img.shields.io/badge/DOI-10.1061%2F%28ASCE%29AS.1943--5525.0001331-blue.svg)](http://dx.doi.org/10.1061/%28ASCE%29AS.1943-5525.0001331)
+
+<br>
+
+# RocketPy
+
+RocketPy is the next-generation trajectory simulation solution for High-Power Rocketry. 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 profiles, 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
+
+1. **Nonlinear 6 Degrees of Freedom Simulations**
+   - Rigorous treatment of mass variation effects
+   - Efficiently solved using LSODA with adjustable error tolerances
+   - Highly optimized for fast performance
+
+2. **Accurate Weather Modeling**
+   - Supports International Standard Atmosphere (1976)
+   - Custom atmospheric profiles and Soundings (Wyoming, NOAARuc)
+   - Weather forecasts, reanalysis, and ensembles for realistic scenarios
+
+3. **Aerodynamic Models**
+   - Optional Barrowman equations for lift coefficients
+   - Easy import of drag coefficients from other sources (e.g., CFD simulations)
+
+4. **Parachutes with External Trigger Functions**
+   - Test the exact code that will fly
+   - Sensor data augmentation with noise for comprehensive parachute simulations
+
+5. **Solid, Hybrid, and Liquid Motors Models**
+   - Burn rate and mass variation properties from the thrust curve
+   - Define custom rocket tanks based on flux data
+   - Support for CSV and ENG file formats
+
+6. **Monte Carlo Simulations**
+   - Conduct dispersion analysis and global sensitivity analysis
+
+7. **Flexible and Modular**
+   - Perform straightforward engineering analysis (e.g., apogee and lift-off speed as a function of mass)
+   - Handle non-standard flights (e.g., parachute drop test from a helicopter)
+   - Support multi-stage rockets and custom continuous/discrete control laws
+   - Easily create new classes, such as other types of motors
+
+8. **Integration with MATLAB®**
+   - Effortlessly run RocketPy from MATLAB®
+   - Convert RocketPy results to MATLAB® variables for further processing
+
+These powerful features make RocketPy an indispensable tool for high-power rocket trajectory simulation, catering to enthusiasts, researchers, and engineers in the field of rocketry.
+
+## Validation
+
+RocketPy's features have been validated in our latest [research article published in the Journal of Aerospace Engineering](http://dx.doi.org/10.1061/%28ASCE%29AS.1943-5525.0001331).
+
+The table below shows a comparison between experimental data and the output from RocketPy.
+Flight data and rocket parameters used in this comparison were kindly provided by [EPFL Rocket Team](https://github.com/EPFLRocketTeam) and [Notre Dame Rocket Team](https://ndrocketry.weebly.com/).
+
+|         Mission         |    Result Parameter    | RocketPy  | Measured  | Relative Error  |
+|:-----------------------:|:-----------------------|:---------:|:---------:|:---------------:|
+|   Bella Lui Kaltbrumn   | Apogee altitude (m)    |   461.03  |   458.97  |   **0.45 %**    |
+|   Bella Lui Kaltbrumn   | Apogee time (s)        |    10.61  |    10.56  |   **0.47 %**    |
+|   Bella Lui Kaltbrumn   | Maximum velocity (m/s) |    86.18  |    90.00  |   **-4.24 %**   |
+|   NDRT launch vehicle   | Apogee altitude (m)    | 1,310.44  | 1,320.37  |   **-0.75 %**   |
+|   NDRT launch vehicle   | Apogee time (s)        |    16.77  |    17.10  |   **-1.90 %**   |
+|   NDRT launch vehicle   | Maximum velocity (m/s) |   172.86  |   168.95  |   **2.31 %**    |
+
+# Documentation
+
+Check out documentation details using the links below:
+
+- [User Guide](https://docs.rocketpy.org/en/latest/user/index.html)
+- [Code Documentation](https://docs.rocketpy.org/en/latest/reference/index.html)
+- [Development Guide](https://docs.rocketpy.org/en/latest/development/index.html)
+- [Technical Documentation](https://docs.rocketpy.org/en/latest/technical/index.html)
+- [Flight Examples](https://docs.rocketpy.org/en/latest/examples/index.html)
+
+<br>
+
+# Join Our Community!
+
+RocketPy is growing fast! Many university groups and rocket hobbyists 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.
+
+If you want to be a part of this and make RocketPy your own, join our [Discord](https://discord.gg/b6xYnNh) server today!
+
+<br>
+
+# Previewing
+
+You can preview RocketPy's main functionalities by browsing through a sample notebook in [Google Colab](https://colab.research.google.com/github/RocketPy-Team/rocketpy/blob/master/docs/notebooks/getting_started_colab.ipynb). No installation is required!
+
+When you are ready to run RocketPy locally, you can read the *Getting Started* section!
+
+<br>
+
+# Getting Started
+
+## Quick Installation
+
+To install RocketPy's latest stable version from PyPI, just open up your terminal and run:
+
+```shell
+pip install rocketpy
+```
+
+For other installation options, visit our [Installation Docs](https://docs.rocketpy.org/en/latest/user/installation.html).
+To learn more about RocketPy's requirements, visit our [Requirements Docs](https://docs.rocketpy.org/en/latest/user/requirements.html).
+
+## Running Your First Simulation
+
+In order to run your first rocket trajectory simulation using RocketPy, you can start a Jupyter Notebook and navigate to the `docs/notebooks` folder. Open `getting_started.ipynb` and you are ready to go. We recommend that you read the [First Simulation](https://docs.rocketpy.org/en/latest/user/first_simulation.html) page to get a complete description.
+
+Otherwise, you may want to create your own script or your own notebook using RocketPy. To do this, let's see how to use RocketPy's four main classes:
+
+- `Environment` - Keeps data related to weather.
+- `Motor` - Subdivided into `SolidMotor`, `HybridMotor` and `LiquidMotor`. Keeps data related to rocket motors.
+- `Rocket` - Keeps data related to a rocket.
+- `Flight` - Runs the simulation and keeps the results.
+
+The following image shows how the four main classes interact with each other:
+
+![Diagram](https://raw.githubusercontent.com/RocketPy-Team/RocketPy/master/docs/static/Fluxogram-Page-2.svg)
+
+A typical workflow starts with importing these classes from RocketPy:
+
+```python
+from rocketpy import Environment, Rocket, SolidMotor, Flight
+```
+
+An optional step is to import datetime, which is used to define the date of the simulation:
+
+```python
+import datetime
+```
+
+Then create an Environment object. To learn more about it, you can use:
+
+```python
+help(Environment)
+```
+
+A sample code is:
+
+```python
+env = Environment(
+    latitude=32.990254,
+    longitude=-106.974998,
+    elevation=1400,
+) 
+
+tomorrow = datetime.date.today() + datetime.timedelta(days=1)
+
+env.set_date(
+  (tomorrow.year, tomorrow.month, tomorrow.day, 12), timezone="America/Denver"
+) # Tomorrow's date in year, month, day, hour UTC format
+
+env.set_atmospheric_model(type='Forecast', file='GFS')
+```
+
+This can be followed up by starting a Solid Motor object. To get help on it, just use:
+
+```python
+help(SolidMotor)
+```
+
+A sample Motor object can be created by the following code:
+
+```python
+Pro75M1670 = SolidMotor(
+    thrust_source="data/motors/Cesaroni_M1670.eng",
+    dry_mass=1.815,
+    dry_inertia=(0.125, 0.125, 0.002),
+    center_of_dry_mass_position=0.317,
+    grains_center_of_mass_position=0.397,
+    burn_time=3.9,
+    grain_number=5,
+    grain_separation=0.005,
+    grain_density=1815,
+    grain_outer_radius=0.033,
+    grain_initial_inner_radius=0.015,
+    grain_initial_height=0.12,
+    nozzle_radius=0.033,
+    throat_radius=0.011,
+    interpolation_method="linear",
+    nozzle_position=0,
+    coordinate_system_orientation="nozzle_to_combustion_chamber",
+)
+```
+
+With a Solid Motor defined, you are ready to create your Rocket object. As you may have guessed, to get help on it, use:
+
+```python
+help(Rocket)
+```
+
+A sample code to create a Rocket is:
+
+```python
+calisto = Rocket(
+    radius=0.0635,
+    mass=14.426,  # without motor
+    inertia=(6.321, 6.321, 0.034),
+    power_off_drag="data/calisto/powerOffDragCurve.csv",
+    power_on_drag="data/calisto/powerOnDragCurve.csv",
+    center_of_mass_without_motor=0,
+    coordinate_system_orientation="tail_to_nose",
+)
+
+buttons = calisto.set_rail_buttons(
+    upper_button_position=0.0818,
+    lower_button_position=-0.6182,
+    angular_position=45,
+)
+
+calisto.add_motor(Pro75M1670, position=-1.255)
+
+nose = calisto.add_nose(
+    length=0.55829, kind="vonKarman", position=1.278
+)
+
+fins = calisto.add_trapezoidal_fins(
+    n=4,
+    root_chord=0.120,
+    tip_chord=0.040,
+    span=0.100,
+    sweep_length=None,
+    cant_angle=0,
+    position=-1.04956,
+)
+
+tail = calisto.add_tail(
+    top_radius=0.0635, bottom_radius=0.0435, length=0.060, position=-1.194656
+)
+```
+
+You may want to add parachutes to your rocket as well:
+
+```python
+main = calisto.add_parachute(
+    name="main",
+    cd_s=10.0,
+    trigger=800,  # ejection altitude in meters
+    sampling_rate=105,
+    lag=1.5,
+    noise=(0, 8.3, 0.5),
+)
+
+drogue = calisto.add_parachute(
+    name="drogue",
+    cd_s=1.0,
+    trigger="apogee",  # ejection at apogee
+    sampling_rate=105,
+    lag=1.5,
+    noise=(0, 8.3, 0.5),
+)
+```
+
+Finally, you can create a Flight object to simulate your trajectory. To get help on the Flight class, use:
+
+```python
+help(Flight)
+```
+
+To actually create a Flight object, use:
+
+```python
+test_flight = Flight(
+  rocket=calisto, environment=env, rail_length=5.2, inclination=85, heading=0
+)
+```
+
+Once the Flight object is created, your simulation is done! Use the following code to get a summary of the results:
+
+```python
+test_flight.info()
+```
+
+To see all available results, use:
+
+```python
+test_flight.all_info()
+```
+
+Here is just a quick taste of what RocketPy is able to calculate. There are hundreds of plots and data points computed by RocketPy to enhance your analyses.
+
+![6-DOF Trajectory Plot](https://raw.githubusercontent.com/RocketPy-Team/RocketPy/master/docs/static/rocketpy_example_trajectory.svg)
+
+If you want to see the trajectory on Google Earth, RocketPy acn easily export a KML file for you:
+
+```python
+test_flight.export_kml(file_name="test_flight.kml")
+```
+
+<img alt="6-DOF Trajectory Plot" src="https://raw.githubusercontent.com/RocketPy-Team/RocketPy/master/docs/static/trajectory-earth.png" width="501">
+
+# Authors and Contributors
+
+This package was originally created by [Giovani Ceotto](https://github.com/giovaniceotto/) as part of his work at [Projeto Jupiter](https://github.com/Projeto-Jupiter/). [Rodrigo Schmitt](https://github.com/rodrigo-schmitt/) was one of the first contributors. Later, [Guilherme Fernandes](https://github.com/Gui-FernandesBR/) and [Lucas Azevedo](https://github.com/lucasfourier/) joined the team to work on the expansion and sustainability of this project.
+
+Since then, the [RocketPy Team](https://github.com/orgs/RocketPy-Team/teams/rocketpy-team) has been growing fast and our contributors are what makes us special!
+
+## Institutional Contributors
+
+RocketPy extends its gratitude to the following institutions for their support and contributions:
+
+<div>
+    <a href="https://github.com/Projeto-Jupiter">
+        <picture align=top>
+            <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/RocketPy-Team/RocketPy/master/docs/static/institutional/projeto_jupiter_dark.png" height="150px">
+            <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/RocketPy-Team/RocketPy/master/docs/static/institutional/projeto_jupiter_light.jpg" height="150px">
+            <img align=top id="projeto-jupiter-image" alt="Projeto Jupiter Logo" src="https://raw.githubusercontent.com/RocketPy-Team/RocketPy/master/docs/static/institutional/projeto_jupiter_light.jpg" height="150px">
+        </picture>
+    </a>
+    <a href="https://github.com/Space-Enterprise-at-Berkeley">
+        <img align=top alt="Space Enterprise at Berkeley Logo" src="https://raw.githubusercontent.com/RocketPy-Team/RocketPy/master/docs/static/institutional/space_enterprise_at_berkeley.jpeg" height="150px">
+    </a>
+</div>
+
+## Individual Contributors
+
+RocketPy is also indebted to a growing list of individual contributors who actively participate in its development. These include:
+
+[![GitHub Contributors Image](https://contrib.rocks/image?repo=RocketPy-Team/RocketPy)](https://github.com/RocketPy-Team/RocketPy/contributors)
+
+See a [detailed list of contributors](https://github.com/RocketPy-Team/RocketPy/contributors) who are actively working on RocketPy.
+
+## Supporting RocketPy and Contributing
+
+The easiest way to help RocketPy is to demonstrate your support by starring our repository!
+
+[![starcharts stargazers over time](https://starchart.cc/rocketpy-team/rocketpy.svg)](https://starchart.cc/rocketpy-team/rocketpy)
+
+You can also become a [sponsor](https://github.com/sponsors/RocketPy-Team) and help us financially to keep the project going.
+
+If you are actively using RocketPy in one of your projects, reaching out to our core team via [Discord](https://discord.gg/b6xYnNh) and providing feedback can help improve RocketPy a lot!
+
+And if you are interested in going one step further, please read [CONTRIBUTING.md](https://github.com/RocketPy-Team/RocketPy/blob/master/CONTRIBUTING.md) for details on our code of conduct and learn more about how you can contribute to the development of this next-gen trajectory simulation solution for rocketry.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE.md](https://github.com/RocketPy-Team/RocketPy/blob/master/LICENSE) file for details
+
+## Release Notes
+
+Want to know which bugs have been fixed and the new features of each version? Check out the [release notes](https://github.com/RocketPy-Team/RocketPy/releases).

rocketpy-1.3.0.dist-info/RECORD

@@ -0,0 +1,5 @@
+rocketpy-1.3.0.dist-info/LICENSE,sha256=yW57cdzzKVxFFK-hmx40XzI86tgd3DNmluc5e4GTShM,1079
+rocketpy-1.3.0.dist-info/METADATA,sha256=Db-dLwzglATOmbvDStFMpamRMWu8yAS6QdzDi5DSqcY,17626
+rocketpy-1.3.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+rocketpy-1.3.0.dist-info/top_level.txt,sha256=RnNaRRe3dIPwwuaamN5QLOgTRBe3nI84kiOvspb0wQE,9
+rocketpy-1.3.0.dist-info/RECORD,,

rocketpy-1.3.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: bdist_wheel (0.43.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

rocketpy-1.3.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+rocketpy