Xrocket

Xrocket is a light-weight rocket simulator designed to provide simulations of rocket dynamics. The simulator allows users to visualize rocket trajectories, save plots for analysis, and operate in a verbose mode for detailed logging.

Features

• Simulation of rocket dynamics with time-step control.
• Options to show plots after the simulation has ended.
• Ability to save the output data and plots for further analysis.
• Verbose mode for detailed debug information.

Installation

Before installing xrocket, ensure you have Python 3.7 or higher installed on your machine.

Prerequisites

• Python 3.7+
• pip (Python package installer)

Installing xrocket

First, clone the xrocket repository from GitHub:

git clone https://github.com/ForbiddenForge/Xrocket.git
cd Xrocket

Install the project and its dependencies using pip:

pip install -r requirements.txt

This command will install xrocket along with the required Python dependencies listed in requirements.txt.

Usage To run the rocket simulator, you can use the command-line interface which provides several options:

python -m xrocket

Command-Line Options

• --show-plots: Display real-time plots of the rocket's trajectory.
• --save-plots: Save the plots to a file for further analysis.
• --verbose: Run the simulator in verbose mode to view detailed logs.
• --help: Display help information about the command-line options.

This command will install the package in editable mode, allowing you to make changes to the code and see them reflected immediately.

Support

For bug reports, feature requests, or further assistance, visit our GitHub Issues page.

License

xrocket is open-source software licensed under the MIT license. For more details, see the LICENSE file in the repository.

Contact

For any additional questions or comments, feel free to reach out via email at ForbiddenForge64@gmail.com.