Skip to content

INTERFACE_OPTIONS.md

Latest commit

 

History

History
446 lines (346 loc) · 9.98 KB

INTERFACE_OPTIONS.md

File metadata and controls

446 lines (346 loc) · 9.98 KB

🖥️ User Interface Options for RocketPy

Your Questions Answered

1. What is the user interface like?

RocketPy has three interface options, all now available to you:

Option A: Command Line Interface (CLI) ✅ CURRENT

What we built:

  • simulate_simplified.py - Run from terminal
  • Python scripts that output results

How to use:

source .venv/bin/activate
python rocketpy_migration/src/simulate_simplified.py

Pros:

  • ✅ Fast
  • ✅ Scriptable/automatable
  • ✅ Good for batch processing
  • ✅ Easy to integrate into pipelines

Cons:

  • ❌ Requires coding knowledge
  • ❌ Not user-friendly for non-programmers
  • ❌ Hard to explore parameters
  • ❌ No visual feedback during run

Best for:

  • Automated simulations
  • Monte Carlo (1000s of runs)
  • CI/CD pipelines
  • Power users

Option B: Web Interface (Streamlit) ✅ JUST CREATED!

What we built:

  • streamlit_app.py - Interactive web app
  • Beautiful, engineer-friendly interface
  • No coding required!

How to use:

source .venv/bin/activate
streamlit run rocketpy_migration/src/streamlit_app.py

Then open your browser to: http://localhost:8502

Features:

  • 🎚️ Sliders & inputs for all parameters
  • 📊 Interactive plots (altitude, velocity, ground track)
  • 💾 Export results to CSV
  • 🔄 Real-time simulation
  • 📝 No coding required
  • 🌐 Team collaboration (can deploy to server)

Pros:

  • ✅ User-friendly (anyone can use)
  • ✅ Visual parameter exploration
  • ✅ Beautiful plots
  • ✅ Easy to share
  • ✅ Professional looking
  • ✅ Engineers LOVE it

Cons:

  • ❌ Slower for batch runs
  • ❌ Needs browser
  • ❌ One simulation at a time (by default)

Best for:

  • Engineering teams
  • Parameter exploration
  • What-if scenarios
  • Presentations
  • Client demos
  • Training

Option C: Jupyter Notebooks (Also Available!)

What you can create:

# interactive_sim.ipynb
from rocketpy import Environment, Motor, Rocket, Flight
import ipywidgets as widgets

# Interactive sliders in notebook
# Live plots
# Documentation + code + results in one place

Pros:

  • ✅ Interactive like Streamlit
  • ✅ Code + results + docs together
  • ✅ Great for research
  • ✅ Easy to share (.ipynb files)

Cons:

  • ❌ Requires Jupyter
  • ❌ Not as polished as Streamlit
  • ❌ Needs some coding knowledge

Best for:

  • Research & development
  • Documentation
  • Teaching
  • Reproducible analysis

📊 Comparison Table

Feature CLI Streamlit Jupyter
Ease of Use ⭐⭐ ⭐⭐⭐⭐⭐ ⭐⭐⭐
Visual Feedback ❌ ✅ ✅
Team Friendly ❌ ✅ ~50%
Performance ⭐⭐⭐⭐⭐ ⭐⭐⭐⭐ ⭐⭐⭐
Batch Processing ✅ ❌ ~50%
Coding Required Yes No Some
Setup Time 1 min 2 min 5 min
Best For Automation Engineers Research

🎯 RECOMMENDATION

For Your Engineers: Use Streamlit ⭐

Why?

  1. Zero coding required - anyone can use it
  2. Beautiful interface - looks professional
  3. Interactive exploration - sliders make it easy to try things
  4. Easy to share - just send them a URL
  5. Built-in plots - no need to export/plot separately
  6. Comments system - can add notes about each run

For Automation: Use CLI

Monte Carlo, optimization, CI/CD → Use the Python scripts

For Research: Use Jupyter

Documentation, teaching, reproducible research → Use notebooks

🚀 Quick Start: Streamlit App

1. Start the app:

cd /Users/anban/opt/share/engineering-projects/pyrops-v0.1
source .venv/bin/activate
streamlit run rocketpy_migration/src/streamlit_app.py

2. Open your browser:

http://localhost:8502

3. Use the app:

  • Left sidebar: Adjust parameters
  • Click "Run Simulation" button
  • View results and plots
  • Download CSV if needed

4. Share with team: If on same network:

streamlit run rocketpy_migration/src/streamlit_app.py --server.address 0.0.0.0

Then share: http://YOUR_IP:8502

💬 Adding Comments Feature

Want engineers to leave comments? Add this to the Streamlit app:

# Add at the bottom of streamlit_app.py

st.header("💬 Comments & Notes")

# Text area for comments
comment = st.text_area(
    "Add notes about this simulation:",
    placeholder="E.g., 'Good configuration for high-altitude launch'"
)

if st.button("💾 Save Comment"):
    # Save to file
    with open('comments.txt', 'a') as f:
        f.write(f"\n{datetime.now()}: {comment}\n")
        f.write(f"Config: Apogee={flight.apogee:.0f}m, "
                f"Wind={wind_speed:.0f}m/s\n")
    st.success("Comment saved!")

# Show previous comments
if Path('comments.txt').exists():
    with open('comments.txt', 'r') as f:
        st.text_area("Previous Comments:", f.read(), height=200)

Or use a database for multi-user:

import sqlite3
# Store comments with simulation parameters
# Tag simulations
# Search comments

🌐 Deployment Options

Option 1: Local Machine (Current)

streamlit run src/streamlit_app.py

Option 2: Office Network

streamlit run src/streamlit_app.py --server.address 0.0.0.0 --server.port 8502
  • Access: http://YOUR_IP:8502 (from any office computer)
  • Users: Anyone on your network
  • Cost: $0

Option 3: Cloud (Streamlit Cloud)

# 1. Push to GitHub
# 2. Go to https://streamlit.io/cloud
# 3. Connect your repo
# 4. Deploy! (automatic)

Option 4: Your Own Server

# Install on Linux server
# Use systemd to run as service
# Add nginx reverse proxy
# Add SSL certificate

📱 Mobile Access?

Yes! Streamlit apps work on mobile browsers:

  • Responsive design (adapts to screen size)
  • Touch-friendly controls
  • Can run simulations from tablet/phone

🎨 Customization

Change Colors/Theme

Create .streamlit/config.toml:

[theme]
primaryColor = "#F63366"
backgroundColor = "#FFFFFF"
secondaryBackgroundColor = "#F0F2F6"
textColor = "#262730"
font = "sans serif"

Add Company Logo

st.logo("your_logo.png")
st.sidebar.image("your_logo.png")

Custom Branding

st.markdown("""
    <style>
    .stApp {
        background-color: your_color;
    }
    </style>
""", unsafe_allow_html=True)

🔒 Security & Authentication

Add Password Protection

import streamlit_authenticator as stauth

# Simple password
password = st.text_input("Password:", type="password")
if password != "your_password":
    st.stop()

# Or use streamlit-authenticator library
# Supports usernames, hashed passwords, cookies

Team Access Control

# Different permissions for different users
if user_role == "engineer":
    # Show full interface
elif user_role == "viewer":
    # Show results only, no run button

💡 Advanced Features

Comparison Mode

col1, col2 = st.columns(2)
with col1:
    st.header("Configuration A")
    # Run simulation A
with col2:
    st.header("Configuration B")
    # Run simulation B
# Plot both on same graph

Save/Load Configurations

# Save button
if st.button("Save Configuration"):
    config = {
        "rail_length": rail_length,
        "wind_speed": wind_speed,
        # ... all parameters
    }
    json.dump(config, open('config.json', 'w'))

# Load button
uploaded = st.file_uploader("Load Configuration")
if uploaded:
    config = json.load(uploaded)
    # Set all parameters

Email Results

import smtplib
from email.mime.text import MIMEText

if st.button("📧 Email Results"):
    email = st.text_input("Email address:")
    # Send simulation results
    send_email(email, results)

📊 Analytics & Tracking

Track Usage

import logging

# Log every simulation
logging.info(f"User ran simulation: apogee={apogee}, "
            f"wind={wind_speed}")

# Analytics dashboard
st.sidebar.metric("Simulations Today", count_today)
st.sidebar.metric("Total Simulations", total_count)

Export Metrics

# Save all runs to database
# Generate reports
# Track parameter trends

🎯 Bottom Line

Answer to Your Question:

"What is the user interface like?"

→ You have 3 options: CLI (command line), Streamlit (web), or Jupyter (notebooks)

"Could we make a Streamlit app?"

→ YES! Already done! ✅ See streamlit_app.py

"Must this be run only from command line?"

→ NO! Use Streamlit for beautiful web interface (no coding required!)

"How simplified is simulate_simplified.py?"

→ Simplified setup, NOT physics! See SIMPLIFICATIONS_AND_SCALING.md → Good for 90% of use cases. Physics is full-fidelity.

"Will it work with complex simulations?"

→ YES! Can do multi-stage, Monte Carlo, custom aero, etc. → RocketPy is production-grade, used by real rocket companies

🚀 Recommended Next Step

Try the Streamlit app RIGHT NOW:

source .venv/bin/activate
streamlit run rocketpy_migration/src/streamlit_app.py

Your engineers will love it! 🎉

Questions? Let me know if you want:

  • Custom features added to Streamlit app
  • Deploy it to a server
  • Add authentication
  • Create the "enhanced" version with full PyROPS data integration
  • Add Monte Carlo mode
  • Anything else!