Skip to content

Usage Guide

Quick Start

Installation

1
pip install waterrocketpy

30-Second Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from waterrocketpy.core.simulation import WaterRocketSimulator
from waterrocketpy.rocket.builder import RocketBuilder,create_standard_rocket

rocket = create_standard_rocket()
builder = RocketBuilder.from_dict(rocket.__dict__)
sim_params = builder.to_simulation_params()

simulator = WaterRocketSimulator()
flight_data = simulator.simulate(sim_params)

print(f"Maximum altitude: {flight_data.max_altitude:.2f} m")

Custom Rocket

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
"""
Minimal test script to verify the water rocket simulation works.
"""

import sys
import os

from waterrocketpy.core.simulation import WaterRocketSimulator
from waterrocketpy.rocket.builder import RocketBuilder,create_standard_rocket

print("✓ All imports successful")

# Create a simple rocket
print("\n1. Creating standard rocket...")
rocket = create_standard_rocket()

print(f"   Rocket created: {rocket.name}")
print(f"   Total mass: {rocket.total_mass:.3f} kg")

# Convert to simulation parameters
print("\n2. Converting to simulation parameters...")
builder = RocketBuilder.from_dict(rocket.__dict__)
sim_params = builder.to_simulation_params()
print(f"   Parameters ready: {len(sim_params)} parameters")

# Run simulation
print("\n3. Running simulation...")
simulator = WaterRocketSimulator()

# Short simulation for testing
sim_settings = {"max_time": 100.0, "time_step": 0.01, "solver": "RK45"}

flight_data = simulator.simulate(sim_params, sim_settings)


print(f"   ✓ Simulation completed successfully!")
print(f"   Maximum altitude: {flight_data.max_altitude:.2f} m")
print(f"   Maximum velocity: {flight_data.max_velocity:.2f} m/s")
print(f"   Flight time: {flight_data.flight_time:.2f} s")
print(f"   Data points: {len(flight_data.time)}")

print("\n✓ Your simulation is working correctly.")

This guide covers the simple examples for WaterRocketPy. For additional examples and detailed API documentation, refer to the API Reference and Example Notebooks.

Future Contents

  1. Quick Start
  2. Basic Simulation
  3. Rocket Configuration
  4. Advanced Analysis
  5. Optimization
  6. Visualization
  7. Data Management
  8. Batch Processing
  9. Common Use Cases
  10. Tips & Best Practices