Update app.py

app.py

@@ -1,5 +1,3 @@
-# boids_streamlit.py
-
 import streamlit as st
 import numpy as np
 import plotly.graph_objects as go
@@ -10,6 +8,7 @@ class Boid:
     def __init__(self, position, velocity):
         self.position = np.array(position, dtype='float64')
         self.velocity = np.array(velocity, dtype='float64')
+        self.acceleration = np.zeros(2, dtype='float64')
         self.history = []
 
     def update(self, boids, width, height, params):
@@ -37,6 +36,7 @@ class Boid:
         self.avoid_others(boids, params)
         self.match_velocity(boids, params)
         self.limit_speed(params)
+        self.avoid_boundaries(width=params['width'], height=params['height'], params=params)
 
     def fly_towards_center(self, boids, params):
         centering_factor = params['centering_factor']
@@ -88,6 +88,20 @@ class Boid:
         if speed > params['max_speed']:
             self.velocity = (self.velocity / speed) * params['max_speed']
 
+    def avoid_boundaries(self, width, height, params):
+        margin = params['boundary_margin']
+        turn_factor = params['boundary_turn_factor']
+
+        if self.position[0] < margin:
+            self.acceleration[0] += turn_factor
+        elif self.position[0] > width - margin:
+            self.acceleration[0] -= turn_factor
+
+        if self.position[1] < margin:
+            self.acceleration[1] += turn_factor
+        elif self.position[1] > height - margin:
+            self.acceleration[1] -= turn_factor
+
     def distance(self, other):
         return np.linalg.norm(self.position - other.position)
 
@@ -101,7 +115,11 @@ params = {
     'matching_factor': 0.05,
     'max_speed': 15.0,
     'draw_trail': False,
-    'max_history': 50
+    'max_history': 50,
+    'width': 800,
+    'height': 600,
+    'boundary_margin': 100.0,
+    'boundary_turn_factor': 0.05
 }
 
 # Streamlitのサイドバーでパラメータを調整
@@ -116,9 +134,13 @@ params['max_speed'] = st.sidebar.slider("Maximum Speed", 5.0, 30.0, 15.0)
 params['draw_trail'] = st.sidebar.checkbox("Draw Trails")
 if params['draw_trail']:
     params['max_history'] = st.sidebar.slider("Trail Length", 10, 100, 50)
+params['boundary_margin'] = st.sidebar.slider("Boundary Margin", 50.0, 300.0, 100.0)
+params['boundary_turn_factor'] = st.sidebar.slider("Boundary Turn Factor", 0.01, 0.2, 0.05)
 
 # シミュレーション画面サイズ
 width, height = 800, 600
+params['width'] = width
+params['height'] = height
 
 # Boidsの初期化
 boids = []
@@ -161,7 +183,98 @@ if params['draw_trail']:
     fig.add_trace(trail_scatter)
 
 # Streamlitのタイトル
-st.title("Boids Simulation")
+st.title("Boids Simulation with Streamlit and Plotly")
+
+# 説明セクション
+st.header("群れアルゴリズムBoidsの数学的背景")
+
+st.markdown(r"""
+### **Boidsアルゴリズムの概要**
+
+Boidsアルゴリズムは、Craig Reynoldsによって1986年に提案された群れ行動のシミュレーション手法です。各エージェント（Boid）は単純なルールに従うことで、複雑な群れ行動を再現します。基本的な3つのルールは以下の通りです：
+
+1. **分離（Separation）**: 隣接するBoidから適切な距離を保ち、衝突を避ける。
+2. **整列（Alignment）**: 隣接するBoidの平均速度に自身の速度を合わせる。
+3. **結合（Cohesion）**: 隣接するBoidの中心に向かって移動する。
+
+### **数式によるモデルの定義**
+
+Boidsの動作は、各エージェントの位置ベクトル \(\mathbf{p}_i(t)\) と速度ベクトル \(\mathbf{v}_i(t)\) で表されます。時間 \(t\) におけるエージェント \(i\) の位置と速度は、以下の微分方程式で記述されます：
+
+\[
+\frac{d\mathbf{p}_i(t)}{dt} = \mathbf{v}_i(t)
+\]
+
+\[
+\frac{d\mathbf{v}_i(t)}{dt} = \mathbf{a}_i(t)
+\]
+
+ここで、加速度 \(\mathbf{a}_i(t)\) は以下の3つの力の合成です：
+
+\[
+\mathbf{a}_i(t) = \mathbf{a}_{\text{separation}} + \mathbf{a}_{\text{alignment}} + \mathbf{a}_{\text{cohesion}}
+\]
+
+#### **1. 分離（Separation）**
+
+Boidが他のBoidと衝突しないようにするための力。エージェント \(i\) と近傍エージェント \(j\) との間の距離を \(d_{ij}\) とすると、分離力 \(\mathbf{a}_{\text{separation}}\) は以下のように定義されます：
+
+\[
+\mathbf{a}_{\text{separation}} = \sum_{j \in N(i)} \frac{\mathbf{p}_i - \mathbf{p}_j}{d_{ij}^2}
+\]
+
+ここで、\(N(i)\) はBoid \(i\) の近傍にいるBoidの集合です。
+
+#### **2. 整列（Alignment）**
+
+Boidが周囲のBoidと同じ方向に移動するようにするための力。近傍Boidの平均速度 \(\mathbf{v}_{\text{avg}}\) を計算し、Boid \(i\) の速度をそれに合わせるための力は以下の通りです：
+
+\[
+\mathbf{a}_{\text{alignment}} = \frac{\mathbf{v}_{\text{avg}} - \mathbf{v}_i}{\tau}
+\]
+
+ここで、\(\tau\) は調整パラメータです。
+
+#### **3. 結合（Cohesion）**
+
+Boidが周囲のBoidの中心に向かって移動するようにするため��力。近傍Boidの中心 \(\mathbf{C}_{\text{avg}}\) を計算し、Boid \(i\) がそこに向かうための力は以下の通りです：
+
+\[
+\mathbf{a}_{\text{cohesion}} = \frac{\mathbf{C}_{\text{avg}} - \mathbf{p}_i}{\sigma}
+\]
+
+ここで、\(\sigma\) は調整パラメータです。
+
+### **アルゴリズムの更新ルール**
+
+各Boidの位置と速度は、離散的な時間ステップ \( \Delta t \) に基づいて更新されます。更新ルールは以下のようになります：
+
+\[
+\mathbf{v}_i(t + \Delta t) = \mathbf{v}_i(t) + \mathbf{a}_i(t) \Delta t
+\]
+
+\[
+\mathbf{p}_i(t + \Delta t) = \mathbf{p}_i(t) + \mathbf{v}_i(t + \Delta t) \Delta t
+\]
+
+これらの式に基づき、各Boidは分離、整列、結合の力を計算し、それに基づいて速度と位置を更新します。
+
+### **追加機能の説明**
+
+本シミュレーションでは、以下の追加機能を実装しています：
+
+1. **境界回避（Boundary Avoidance）**: シミュレーション領域の端にBoidが近づくと、Boidが逆方向に加速度を受けて領域内に留まるようにします。これにより、Boidが画面外に出ることを防ぎます。
+
+2. **トレイル描画（Trail Drawing）**: Boidの過去の位置をトレイルとして表示し、動きの軌跡を視覚化します。これにより、Boidの動きのパターンを追跡することが容易になります。
+
+### **パラメータの追加とその役割**
+
+- **Boundary Margin (\(M\))**: シミュレーション領域の端からBoidが回避を開始する距離。
+- **Boundary Turn Factor (\(\gamma\))**: 境界回避力の強さを調整する係数。
+
+これらのパラメータにより、Boidが領域の端に近づいた際の挙動を細かく制御できます。
+
+""", unsafe_allow_html=True)
 
 # アニメーションの表示領域
 animation_placeholder = st.empty()
@@ -179,6 +292,7 @@ if st.sidebar.button("Reset Simulation"):
         velocity = [np.cos(angle), np.sin(angle)]
         boids.append(Boid(position, velocity))
 
+# アニメーションの実行ループ
 while True:
     # Boidsの更新
     for boid in boids:
@@ -209,4 +323,4 @@ while True:
     animation_placeholder.plotly_chart(fig, use_container_width=True)
 
     # フレームレート調整
-    time.sleep(sleep_time)
+    time.sleep(sleep_time)