Skip to content

Commit 1d48998

Browse files
committed
Update readme
1 parent e914ec0 commit 1d48998

1 file changed

Lines changed: 14 additions & 19 deletions

File tree

README.md

Lines changed: 14 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -3,22 +3,18 @@
33
ActiveRocketPy is the enhanced version of [RocketPy](https://github.com/RocketPy-Team/RocketPy), a powerful Python package for simulating the trajectories of high-power rockets. This fork introduces a range of active control and guidance, navigation, and control (GNC) features.
44

55
## Main features (ActiveRocketPy)
6-
1. **Thrust Vector Control (TVC)**
7-
- Implementation of TVC control class
8-
- Feed X & Y gimbal angles through a control function
9-
- Actuator dynamics and limits for realistic TVC simulations (WIP)
10-
11-
2. **Roll Control**
12-
- Implementation of roll control class
13-
- Feed ideal roll torque through a control function
14-
- Actuator dynamics and limits for realistic roll control simulations (WIP)
15-
16-
3. **Throttle Control**
17-
- Implementation of throttle control class
18-
- Feed throttle percentage through a control function
19-
- Actuator dynamics and limits for realistic throttle control simulations (WIP)
20-
21-
4. **Step simulation**
6+
7+
1. **Actuator Classes for active control**
8+
- Actuator dynamics and limits for realistic active flight simulations
9+
- **Thrust Vector Control (TVC)**
10+
- Feed X & Y gimbal angles through a control function
11+
- **Roll Control**
12+
- Feed ideal roll torque through a control function
13+
- **Throttle Control**
14+
- Feed throttle percentage through a control function
15+
- Known limitation: The mass properties are pre-calculated before flight according to max flow rate and burn time. Throttle commands does not affect the change of the mass properties in-flight. It is equivalent to throttling the Isp of rocket engine while the flow rate remains constant. The engine is cut off when burn time is reached
16+
17+
2. **Step simulation**
2218
- Step through the simulation one time step at a time
2319
- Update control inputs and step simulations in loop
2420

@@ -76,7 +72,6 @@ Check out documentation details using the links below:
7672
- [RocketPy Technical Documentation](https://docs.rocketpy.org/en/latest/technical/index.html)
7773
- [RocketPy Flight Examples](https://docs.rocketpy.org/en/latest/examples/index.html)
7874

79-
8075
<br>
8176

8277
# Getting Started
@@ -100,7 +95,6 @@ pip install -r requirements-tests.txt # install test/dev requirements
10095
10196
ActiveRocketPy is forked and maintained by [ZuoRen Chen](https://github.com/zuorenchen), along with the team from [Advanced Rocket Research Center (ARRC)](https://github.com/ARRC-Rocket).
10297

103-
10498
## Citation
10599

106100
If you run ActiveRocketPy in your research, please consider citing:
@@ -114,4 +108,5 @@ If you run ActiveRocketPy in your research, please consider citing:
114108
url = {https://github.com/ARRC-Rocket/ActiveRocketPy}
115109
}
116110
```
117-
To cite RocketPy, please check its repository for the latest citation information: [RocketPy](https://github.com/RocketPy-Team/RocketPy)
111+
112+
To cite RocketPy, please check its repository for the latest citation information: [RocketPy](https://github.com/RocketPy-Team/RocketPy)

0 commit comments

Comments
 (0)