Skip to content

Commit 2f8c63a

Browse files
Merge pull request #104 from Projeto-Jupiter/changes_readme
Now our readme has a logo!
2 parents 147b897 + e235b03 commit 2f8c63a

File tree

2 files changed

+2798
-9
lines changed

2 files changed

+2798
-9
lines changed

README.md

Lines changed: 37 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,24 @@
1+
![RocketPy Logo](https://raw.githubusercontent.com/Projeto-Jupiter/RocketPy/master/docs/static/RocketPy_Logo_Black.svg)
2+
3+
<br>
4+
15
[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/giovaniceotto/rocketpy/blob/master/docs/notebooks/getting_started_colab.ipynb)
26
[![PyPI](https://img.shields.io/pypi/v/rocketpy?color=g)](https://pypi.org/project/rocketpy/)
37
[![Documentation Status](https://readthedocs.org/projects/rocketpyalpha/badge/?version=latest)](https://docs.rocketpy.org/en/latest/?badge=latest)
48
[![Build Status](https://app.travis-ci.com/Projeto-Jupiter/RocketPy.svg?branch=master)](https://app.travis-ci.com/Projeto-Jupiter/RocketPy)
5-
[![Chat on Discord](https://img.shields.io/discord/765037887016140840?logo=discord)](https://discord.gg/b6xYnNh)
69
[![Contributors](https://img.shields.io/github/contributors/Projeto-Jupiter/rocketpy)](https://github.com/Projeto-Jupiter/RocketPy/graphs/contributors)
10+
[![Chat on Discord](https://img.shields.io/discord/765037887016140840?logo=discord)](https://discord.gg/b6xYnNh)
711
[![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=flat&logo=linkedin&logoColor=white)](https://www.linkedin.com/company/rocketpy)
812
[![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)
913

14+
<br>
15+
1016
# RocketPy
1117
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 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.
1218

13-
## Main features
19+
<br>
1420

21+
## Main features
1522
<details>
1623
<summary>Nonlinear 6 degrees of freedom simulations</summary>
1724
<ul>
@@ -74,6 +81,7 @@ RocketPy is the next-generation trajectory simulation solution for High-Power Ro
7481
<li>Create new classes (e.g. other types of motors)</li>
7582
</ul>
7683
</details>
84+
7785
<br>
7886

7987
## Validation
@@ -92,6 +100,7 @@ Flight data and rocket parameters used in this comparison were kindly provided b
92100
| NDRT launch vehicle | Apogee time (s) | 16.77 | 17.10 | **-1.90 %** |
93101
| NDRT launch vehicle | Maximum velocity (m/s) | 172.86 | 168.95 | **2.31 %** |
94102

103+
<br>
95104

96105
## Documentation
97106

@@ -101,20 +110,26 @@ Check out documentation details using the links below:
101110
- [Code Documentation](https://docs.rocketpy.org/en/latest/reference/index.html)
102111
- [Development Guide](https://docs.rocketpy.org/en/latest/development/index.html)
103112

104-
## Join Our Community!
113+
<br>
114+
115+
# Join Our Community!
105116
RocketPy is growing fast! Many university 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.
106117

107118
If you want to be a part of this and make RocketPy your own, join our [Discord](https://discord.gg/b6xYnNh) server today!
108119

109-
## Previewing
120+
<br>
121+
122+
# Previewing
110123

111124
You can preview RocketPy's main functionalities by browsing through a sample notebook in [Google Colab](https://colab.research.google.com/github/giovaniceotto/rocketpy/blob/master/docs/notebooks/getting_started_colab.ipynb). No installation required!
112125

113126
When you are ready to run RocketPy locally, you can read the *Getting Started* section!
114127

115-
## Getting Started
128+
<br>
129+
130+
# Getting Started
116131

117-
### Quick Installation
132+
## Quick Installation
118133

119134
To install RocketPy's latest stable version from PyPI, just open up your terminal and run:
120135

@@ -125,7 +140,9 @@ pip install rocketpy
125140
For other installation options, visit our [Installation Docs](https://docs.rocketpy.org/en/latest/user/installation.html).
126141
To learn more about RocketPy's requirements, visit our [Requirements Docs](https://docs.rocketpy.org/en/latest/user/requirements.html).
127142

128-
### Running Your First Simulation
143+
<br>
144+
145+
## Running Your First Simulation
129146

130147
In order to run your first rocket trajectory simulation using RocketPy, you can start a Jupyter Notebook and navigate to the _nbks_ folder. Open _Getting Started - Examples.ipynb_ and you are ready to go.
131148

@@ -268,7 +285,13 @@ To seel all available results, use:
268285
TestFlight.allInfo()
269286
```
270287

271-
## Authors and Contributors
288+
Here is just a quick taste of what RocketPy is able to calculate. There are hundred of plots and data points computed by RocketPy to enhance your analyses.
289+
290+
![6-DOF Trajectory Plot](docs/static/rocketpy_example_trajectory.svg)
291+
292+
<br>
293+
294+
# Authors and Contributors
272295

273296
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.
274297

@@ -284,14 +307,19 @@ See a [detailed list of contributors](https://github.com/Projeto-Jupiter/RocketP
284307

285308
The easiest way to help RocketPy is to demonstrate your support by starring our repository! ![GitHub Repo stars](https://img.shields.io/github/stars/Projeto-Jupiter/RocketPy?style=social)
286309

310+
<br>
311+
287312
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!
288313

289314
And if you are interested in going one step further, please read [CONTRIBUTING.md](https://github.com/Projeto-Jupiter/RocketPy/blob/master/CONTRIBUTING.md) for details on our code of conduct and learn more on how you can contribute with the development of this next-gen trajectory simulation solution for rocketry.
290315

316+
<br>
317+
291318
## License
292319

293320
This project is licensed under the MIT License - see the [LICENSE.md](https://github.com/Projeto-Jupiter/RocketPy/blob/master/LICENSE) file for details
294321

322+
<br>
323+
295324
## Release Notes
296325
Want to know which bugs have been fixed and new features of each version? Check out the [release notes](https://github.com/Projeto-Jupiter/RocketPy/releases).
297-

0 commit comments

Comments
 (0)