Expand description
The library facade of FusionSpace HPR · Sim: a builder API for environments, motors, rockets and flights, and the workspace’s crates re-exported.
The guide has three pages to start from. Start here says what works and how far
to trust it. Getting started flies a first rocket. The builder
walks through this crate’s API. The guide module is the same walk-through in this
reference, in five short chapters.
Four types make a flight, in the order a program needs them:
Environment: the launch site, the atmosphere and the wind.Motor: a motor from the built-in catalog or a RASP.engfile.Rocket: parts added from the nose back, the motor, and the recovery devices.Flight: the rocket flown from a rail, with its apogee, speeds and landing.
How far to trust it. The builder adds no physics of its own. It makes the same design tree and flies the same simulation as the crates below it. A test flies a rocket built both ways to the same numbers, bit for bit. So its numbers are as good as those models are. The guide’s Accuracy page says how good that is, with every comparison made.
use hpr::rocket::{Fins, Mass, MotorTube, Nose, Tube, material};
use hpr::{
CanopyType, Device, DeviceDrag, Environment, FinPlanform, Flight, Motor, NoseShape,
Position, Rocket, Trigger,
};
let environment = Environment::new(32.99, -106.97, 1400.0)?;
let ogive = NoseShape::Ogive { radius_ratio: 1.0 };
let planform = FinPlanform::Trapezoidal {
root_chord_m: 0.1,
tip_chord_m: 0.04,
span_m: 0.045,
sweep_m: 0.05,
};
let mut rocket = Rocket::new("Small", 0.0563)?;
rocket
.add_nose(Nose::hollow(ogive, 0.22, 0.0015, material("abs")?))?
.add_tube(Tube::new(0.9, 0.00115, material("kraft_phenolic")?))?
.add_fins(Fins::new(3, planform, 0.003175, material("birch_plywood")?))?
.add_motor_tube(MotorTube::new(0.2, 0.029, 0.001, material("kraft_phenolic")?))?
.add_mass(Mass::new(0.2, Position::Top { aft_offset_m: 0.07 }))?
.set_motor(Motor::from_catalog("H54")?.with_delay_s(10.0)?)?
.add_parachute(Device::new(
"parachute",
DeviceDrag::canopy(CanopyType::FlatCircular, 0.9),
Trigger::MotorDelay { motor: 0 },
));
let flight = Flight::builder(&rocket, &environment, 1.8).fly()?;
assert!(flight.apogee_m().is_some_and(|apogee_m| apogee_m > 1000.0));The builder makes the same things the crates below it use, and hands them over. A rocket’s
Rocket::design is an hpr_design::Rocket, and a flight’s FlightBuilder::simulation
is an hpr_sim::Simulation. For what the builder doesn’t offer, such as staging, clusters,
pods or mass shifts, build with the crates, which this one re-exports by name. Each covers
one part of the work:
hpr_core: the math, units, frames, the Earth and gravity.hpr_atmos: the atmosphere and the wind.hpr_motor: solid motors, their thrust curves and motor files.hpr_design: a rocket’s parts, materials, mass and stages.hpr_aero: the aerodynamics: normal force, center of pressure and drag.hpr_sim: the flight itself, in six degrees of freedom, with recovery.hpr_analysis: Monte Carlo runs, sensitivity analysis and optimization.hpr_format: HPR’s own design format.hpr_io: other programs’ files: OpenRocket designs and parts, weather and elevation.hpr_flightdata: flight logs and the readings taken from them, with no simulator.hpr_forensics: a flight log against a simulation of it, planned; today it holds only synthetic flights to test the readings on.
The net feature adds hpr-net (as hpr::hpr_net). It holds the cache, the offline mode and
the HTTP transport, and these sources:
hpr_net::open_meteo: a launch site’s weather from Open-Meteo.hpr_net::wyoming: weather-balloon soundings from the University of Wyoming’s archive.hpr_net::nomads: NOAA’s GFS and RAP forecasts.hpr_net::elevation: a site’s height above sea level from Open-Meteo.hpr_net::motor_finder: motor stock and prices from motor.fusionspace.co.hpr_net::thrustcurve: motor records and thrust curves from ThrustCurve.org.
The parquet feature turns on hpr_sim’s Parquet export (hpr_sim::export::parquet).
ork flies the stage separation an OpenRocket .ork file describes.
Re-exports§
pub use environment::Environment;pub use error::CatalogProblem;pub use error::Error;pub use error::Order;pub use flight::Flight;pub use flight::FlightBuilder;pub use motor::Motor;pub use rocket::Rocket;pub use hpr_aero;pub use hpr_analysis;pub use hpr_atmos;pub use hpr_core;pub use hpr_design;pub use hpr_flightdata;pub use hpr_forensics;pub use hpr_format;pub use hpr_io;pub use hpr_motor;pub use hpr_net;pub use hpr_sim;
Modules§
- environment
- Where and in what weather a rocket flies.
- error
- The facade’s error type.
- flight
- A flight: a rocket launched from a rail in an environment, flown to the ground.
- guide
- A guide to the
hprcrate, in the API reference: what to read first, and how the pieces fit. - motor
- A solid rocket motor, ready to go in a rocket’s motor tube.
- ork
- Flying what an OpenRocket
.orkfile says about staging and recovery. - rocket
- A rocket built part by part, from the nose back.
Structs§
- Device
- A recovery device: a drag area, when it opens, and how it fills.
- Separation
- A separation: the stack comes apart at a stage boundary and every body descends under its own
devices (
docs/physics/recovery.md, and the decision record on separation, ADR-014).
Enums§
- Canopy
Type - A canopy type with printed data in Knacke’s tables.
- Device
Drag - What gives a device its drag area
C_D S. - Envelope
Flag - One flag a flight raises, with the peak that raised it. Serialized with a
flagtag in snake case. - FinCross
Section - The shape of a fin’s section along its chord.
- FinPlanform
- The outline of one fin.
- Nose
Shape - The shape of a nose cone, or of a transition’s profile.
- Position
- Where an attached part sits along its parent. Offsets are positive aft.
- Trigger
- When a device’s charge fires.