Refactoring and adding simulator to README.md

README.md

@@ -5,7 +5,7 @@ colorFrom: purple
 colorTo: gray
 sdk: streamlit
 sdk_version: 1.17.0
-app_file: app.py
+app_file: Disc Golf Simulator.py
 pinned: false
 license: gpl-3.0
 ---

bootstrap.py

@@ -3,7 +3,7 @@ import streamlit.web.bootstrap
 from streamlit import config as _config
 
 proj_dir = Path(__file__).parent
-filename = proj_dir / "app" / "app.py"
+filename = proj_dir / "Disc Golf Simulator.py"
 
 _config.set_option("server.headless", True)
 args = []

examples/disc_experimental_trajectory_comparison.py

@@ -1,106 +0,0 @@
-# -*- coding: utf-8 -*-
-
-import sys
-from shotshaper.projectile import DiscGolfDisc
-import matplotlib.pyplot as pl
-import numpy as np
-import shotshaper.environment as env
-from shotshaper.transforms import T_12
-from random import uniform
-
-
-def rotz(pos,betad):
-    beta = np.radians(betad)
-    TZ =  np.array([[np.cos(beta), -np.sin(beta), 0],
-                    [np.sin(beta),  np.cos(beta), 0],
-                    [0,             0,            1]])
-
-    return np.matmul(TZ,pos)
-
-throws=[1,6,15]
-
-nthrow = len(throws)
-        # pitch, roll, nose,speed,spin,  yaw,  wind, length
-params = [[15.5, 21.8, 0.0, 24.7, 138, -31.6, 4.8, 89.7],
-          [12.3, 14.7, 0.8, 24.2, 128.5, -9.60, 4.8, 87.0],
-          [5.20,-0.70, 0.0, 24.5, 147.7,  8.00, 4.8, 106.6]]
-         
-
-d = DiscGolfDisc('dd2')
-fig1, ax1 = pl.subplots( )
-    
-fig1.set_figheight(4)
-fig1.set_figwidth(6)
-
-for i in range(nthrow):
-    p = params[i]
-    t = throws[i]
-    U = p[3]
-    omega = p[4]
-    z0 = 1.5
-    pos = np.array((0,0,z0))
-    pitch = p[0]
-    yaw = p[5]
-    nose = p[2]
-    roll = p[1]
-    
-    env.Uref = p[6]
-    env.winddir = np.array((1,0,0))
-
-    # Currently handle yaw by rotating the position after the throw, hence
-    # also need to rotate the wind vector accordingly
-    env.winddir = rotz(env.winddir, -yaw)
-
-    s = d.shoot(speed=U, omega=omega, pitch=pitch, position=pos, nose_angle=nose, roll_angle=roll)
-
-    pos = s.position
-    for j in range(len(pos[0,:])):
-        pos[:,j] = rotz(pos[:,j], yaw)
-    x,y,z = pos
-    arc,alphas,betas,lifts,drags,moms,rolls = d.post_process(s, omega)
-    
-    # Plot trajectory
-    ax1.plot(x,y,f'C{i}-')
-    
-    # Experiment
-    te,xe,ye,ve = np.loadtxt(f'data/throw{t}',skiprows=2,unpack=True)
-    ax1.plot(xe,ye,f'C{i}--')
-
-    ax1.set_xlabel('Distance (m)')
-    ax1.set_ylabel('Drift (m)')
-    ax1.axis('equal')
-    
-    # Plot other parameters
-    
-    # axes[0,0].plot(arc, lifts)
-    # axes[0,0].set_xlabel('Distance (m)')
-    # axes[0,0].set_ylabel('Lift force (N)')
-    
-    # axes[0,1].plot(arc, drags)
-    # axes[0,1].set_xlabel('Distance (m)')
-    # axes[0,1].set_ylabel('Drag force (N)')
-    
-    # axes[0,2].plot(arc, moms)
-    # axes[0,2].set_xlabel('Distance (m)')
-    # axes[0,2].set_ylabel('Moment (Nm)')
-    
-    # axes[1,0].plot(arc, alphas)
-    # axes[1,0].set_xlabel('Distance (m)')
-    # axes[1,0].set_ylabel('Angle of attack (deg)')
-    
-    # axes[1,1].plot(arc, s.velocity[0,:])
-    # axes[1,1].plot(arc, s.velocity[1,:])
-    # axes[1,1].plot(arc, s.velocity[2,:])
-    # axes[1,1].set_xlabel('Distance (m)')
-    # axes[1,1].set_ylabel('Velocities (m/s)')
-    
-    # axes[1,2].plot(arc, rolls)
-    # axes[1,2].set_xlabel('Distance (m)')
-    # axes[1,2].set_ylabel('Roll rate (rad/s)')
-
-pl.tight_layout()
-pl.show()
-
-
-
-

examples/disc_golf_throw.py

@@ -1,66 +0,0 @@
-# -*- coding: utf-8 -*-
-"""
-Example showing a single disc throw.
-"""
-
-from shotshaper.projectile import DiscGolfDisc
-import matplotlib.pyplot as pl
-import numpy as np
-import plotly.express as px
-
-d = DiscGolfDisc('dd2')
-U = 24.2
-omega = 116.8
-z0 = 1.3
-pos = np.array((0,0,z0))
-pitch = 15.5
-nose = 0.0
-roll = 14.7
-
-shot = d.shoot(speed=U, omega=omega, pitch=pitch, 
-               position=pos, nose_angle=nose, roll_angle=roll)
-
-# Plot trajectory
-pl.figure(1)
-x,y,z = shot.position
-pl.plot(x,y)
-fig = px.scatter(x,y)
-fig.show()
-
-pl.xlabel('Distance (m)')
-pl.ylabel('Drift (m)')
-pl.axis('equal')
-
-# Plot other parameters
-arc,alphas,betas,lifts,drags,moms,rolls = d.post_process(shot, omega)
-fig, axes = pl.subplots(nrows=2, ncols=3, dpi=80,figsize=(13,5))
-
-axes[0,0].plot(arc, lifts)
-axes[0,0].set_xlabel('Distance (m)')
-axes[0,0].set_ylabel('Lift force (N)')
-
-axes[0,1].plot(arc, drags)
-axes[0,1].set_xlabel('Distance (m)')
-axes[0,1].set_ylabel('Drag force (N)')
-
-axes[0,2].plot(arc, moms)
-axes[0,2].set_xlabel('Distance (m)')
-axes[0,2].set_ylabel('Moment (Nm)')
-
-axes[1,0].plot(arc, alphas)
-axes[1,0].set_xlabel('Distance (m)')
-axes[1,0].set_ylabel('Angle of attack (deg)')
-
-axes[1,1].plot(arc, shot.velocity[0,:])
-axes[1,1].plot(arc, shot.velocity[1,:])
-axes[1,1].plot(arc, shot.velocity[2,:])
-axes[1,1].set_xlabel('Distance (m)')
-axes[1,1].set_ylabel('Velocities (m/s)')
-axes[1,1].legend(('u','v','w'))
-
-axes[1,2].plot(arc, rolls)
-axes[1,2].set_xlabel('Distance (m)')
-axes[1,2].set_ylabel('Roll rate (rad/s)')
-pl.tight_layout()
-
-pl.show()

examples/disc_gui2d.py

@@ -1,105 +0,0 @@
-# -*- coding: utf-8 -*-
-"""
-Graphical user interface to explore the influence
-of disc throw parameters on the trajectory
-"""
-
-import numpy as np
-import matplotlib.pyplot as pl
-from matplotlib.widgets import Slider, TextBox
-from shotshaper.projectile import DiscGolfDisc
-
-name = 'dd2'
-mass = 0.175
-
-d = DiscGolfDisc(name, mass=mass)
-speed = 24
-omega = d.empirical_spin(speed)
-z0 = 1.3
-pos = np.array((0,0,z0))
-pitch = 10
-nose = 0.0
-roll = 15.0  
-yaw = 0
-adjust_axes = False
-     
-s = d.shoot(speed=speed, omega=omega, pitch=pitch, position=pos, nose_angle=nose, roll_angle=roll,yaw=yaw)
-
-x,y,z = s.position
-
-# Creating figure
-fig = pl.figure(1,figsize=(13, 6), dpi=80)
-ax1 = pl.subplot(2,3,2)
-ax2 = pl.subplot(2,3,5)
-ax3 = pl.subplot(1,3,3)
-fac = 1.6
-ylim = fac*max(abs(min(y)),abs(max(y)))
-ax1.axis((min(x),fac*max(x),-ylim,ylim))
-ax2.axis((min(x),fac*max(x),min(z),fac*max(z)))
-ax3.axis((-ylim,ylim,min(z),fac*max(z)))
-        
-ax3.invert_xaxis()
-
-l1, = ax1.plot(x,y,lw=2)
-ax1.set_xlabel('Distance (m)')
-ax1.set_ylabel('Drift (m)')
-l2, = ax2.plot(x,z,lw=2)
-ax2.set_xlabel('Distance (m)')
-ax2.set_ylabel('Height (m)')
-
-l3, = ax3.plot(y,z,lw=2)
-ax3.set_xlabel('Drift (m)')
-ax3.set_ylabel('Height (m)')
-
-xax = 0.07
-ax4  = pl.axes([xax, 0.80, 0.25, 0.03], facecolor='lightgrey')
-ax5  = pl.axes([xax, 0.75, 0.25, 0.03], facecolor='lightgrey')
-ax6  = pl.axes([xax, 0.70, 0.25, 0.03], facecolor='lightgrey')
-#ax7  = pl.axes([xax, 0.65, 0.25, 0.03], facecolor='lightgrey')
-ax8  = pl.axes([xax, 0.65, 0.25, 0.03], facecolor='lightgrey')
-ax9  = pl.axes([xax, 0.60, 0.25, 0.03], facecolor='lightgrey')
-ax11 = pl.axes([xax, 0.55, 0.25, 0.03], facecolor='lightgrey')
-
-s1 = Slider(ax=ax4, label='Speed (m/s)', valmin=15,  valmax=35, valinit=speed)
-s2 = Slider(ax=ax5, label='Roll (deg)',   valmin=-110, valmax=110, valinit=roll)
-s3 = Slider(ax=ax6, label='Pitch (deg)', valmin=-10,   valmax=50, valinit=pitch)
-s5 = Slider(ax=ax8, label='Nose (deg)',   valmin=-5, valmax=5, valinit=nose)
-s7 = Slider(ax=ax9, label='Mass (kg)',   valmin=0.140, valmax=0.200, valinit=mass)
-s6 = Slider(ax=ax11, label='Spin (-)',   valmin=0, valmax=2, valinit=1.0)
-
-def update(x):
-    speed = s1.val
-    roll = s2.val
-    pitch = s3.val
-    nose = s5.val
-    spin = s6.val
-    mass = s7.val 
-    d = DiscGolfDisc(name,mass=mass)
-    
-    omega = spin*d.empirical_spin(speed)
-    s = d.shoot(speed=speed, omega=omega, pitch=pitch, position=pos, nose_angle=nose, roll_angle=roll)
-    x,y,z = s.position
-    
-    l1.set_xdata(x)
-    l1.set_ydata(y)
-    l2.set_xdata(x)
-    l2.set_ydata(z)
-    l3.set_xdata(y)
-    l3.set_ydata(z)
-    
-    if adjust_axes:
-        ax1.axis((min(x),max(x),min(y),max(y)))
-        ax2.axis((min(x),max(x),min(z),max(z)))
-        ax3.axis((min(y),max(y),min(z),max(z)))
-        
-    fig.canvas.draw_idle()
-
-s1.on_changed(update)
-s2.on_changed(update)
-s3.on_changed(update)
-s5.on_changed(update)
-s6.on_changed(update)
-s7.on_changed(update)
-
-pl.show()
-    

examples/driver.py

@@ -1,35 +0,0 @@
-# -*- coding: utf-8 -*-
-"""
-Simple example comparing different projectiles.
-"""
-
-from shotshaper.projectile import _Particle, ShotPutBall, SoccerBall
-import matplotlib.pyplot as pl
-import numpy as np
-
-U = 10.0
-angle = 20.0
-
-p = _Particle()
-shot = p.shoot(speed=U, pitch=angle)
-pl.plot(shot.position[0,:],shot.position[2,:])
-
-p = ShotPutBall('M')
-shot = p.shoot(speed=U, pitch=angle)
-pl.plot(shot.position[0,:],shot.position[2,:])
-
-p = SoccerBall()
-
-spin = np.array((0,0,0))
-shot = p.shoot(speed=U, pitch=angle, spin=spin)
-pl.plot(shot.position[0,:],shot.position[2,:])
-
-spin = np.array((0,-10,0))
-shot = p.shoot(speed=U, pitch=angle, spin=spin)
-pl.plot(shot.position[0,:],shot.position[2,:])
-
-pl.legend(('vacuum','air', 'no spin','spin'))
-
-pl.show()
-
-

examples/validation_balls.py

@@ -1,50 +0,0 @@
-# -*- coding: utf-8 -*-
-"""
-This program calculates trajectories that were experimentally conducted in
-
-Mencke, J. E., Salewski, M., Trinhammer, O. L., & Adler, A. T. (2020). 
-Flight and bounce of spinning sports balls. American Journal of Physics, 
-88(11), 934-947.
-
-Specifically, this includes data for:
-    - a shot put throw, representing a heavy projectile where the 
-      gravitational forces dominate over the aerodynamic forces
-    - a soccer ball, with slightly more influence of air drag
-    - a table tennis ball, significantly impacted by air drag due
-      to low weight
-"""
-
-from shotshaper.projectile import SoccerBall, ShotPutBall, TableTennisBall
-import matplotlib.pyplot as pl
-import numpy as np
-
-cases = ('Shot','Soccer ball','Table tennis ball')
-projectiles = (ShotPutBall('M'), SoccerBall(), TableTennisBall())
-ux = (9.0, 11.0, 11.8)
-uy = (7.1, 10.2, 12.0)
-z0 = (2.4, 0.0, 1.0)
-spin = (0,0,0)
-
-f, ax = pl.subplots(1, 1, figsize=(6,4))
-for i,c in enumerate(cases):
-    speed = np.sqrt(ux[i]**2 + uy[i]**2)
-    pitch = np.degrees(np.arctan2(uy[i],ux[i]))
-    position = (0, 0, z0[i])
-    
-    s = projectiles[i].shoot(speed=speed,pitch=pitch,position=position,spin=spin)
-
-    x,y,z = s.position
-
-    ax.plot(x,z,'C0-')
-    ax.text(x[0]-0.5, z[0], c, fontsize=9, ha='right')
-    
-    x,z = np.loadtxt(f'data/{c}_trajectory.dat', unpack=True, delimiter=';')
-    ax.plot(x,z,'C1--')
-    
-ax.legend(('Simulation','Experiment'))
-ax.axis((-10,25,-1,6))
-    
-pl.xlabel('Length (m)')
-pl.ylabel('Height (m)')
-
-pl.show()

examples/validation_spinning_ball.py

@@ -1,48 +0,0 @@
-# -*- coding: utf-8 -*-
-"""
-This program calculates the trajectory of a spinning soccer ball
-that was experimentally investigated in
-
-Mencke, J. E., Salewski, M., Trinhammer, O. L., & Adler, A. T. (2020). 
-Flight and bounce of spinning sports balls. American Journal of Physics, 
-88(11), 934-947.
-
-"""
-
-from shotshaper.projectile import SoccerBall
-import matplotlib.pyplot as pl
-import numpy as np
-from scipy.linalg import norm
-
-ball = SoccerBall()
-u = np.array([20.0, 2.5, 4.9])
-# Note that spin is here negative along the z-axis, as opposed
-# to positive around the y-axis, since we define z as upwards,
-# while Mencke et al. define y as upwards 
-spin = (0,0,-46) 
-speed = norm(u)
-pitch = np.degrees(np.arctan2(u[2],u[0]))
-yaw = -np.degrees(np.arctan2(u[1],u[0]))
-    
-s = ball.shoot(speed=speed,pitch=pitch,yaw=yaw,spin=spin)
-
-x,y,z = s.position
-
-f, (ax1, ax2) = pl.subplots(2, 1, figsize=(5,7))
-
-ax1.plot(x,z,'C0-')
-ax2.plot(x,y,'C0-')    
-x,z = np.loadtxt('data/Spin_z_trajectory.dat', unpack=True, delimiter=';')
-ax1.plot(x,z,'C1--')
-x,y = np.loadtxt('data/Spin_y_trajectory.dat', unpack=True, delimiter=';')
-ax2.plot(x,y,'C1--')    
-
-ax1.legend(('Simulation','Experiment'))
-ax2.legend(('Simulation','Experiment'))
-    
-ax1.set_xlabel('Length (m)')
-ax1.set_ylabel('Height (m)')
-ax2.set_xlabel('Length (m)')
-ax2.set_ylabel('Drift (m)')
-
-pl.show()