coredipper commited on
Commit
9ae0115
Β·
verified Β·
1 Parent(s): 83dd707

docs: improve README with usage instructions

Browse files
Files changed (2) hide show
  1. README.md +10 -8
  2. requirements.txt +1 -1
README.md CHANGED
@@ -11,18 +11,20 @@ license: mit
11
  short_description: Morphogen gradient formation on graph topologies
12
  ---
13
 
14
- # 🌊 Diffusion β€” Morphogen Gradient Visualizer
15
 
16
- Simulate **morphogen diffusion** across graph topologies and watch concentration gradients form β€” the spatial coordination layer of Operon.
17
 
18
- ## Features
19
 
20
- - **Tab 1 β€” Linear Chain**: Emit morphogen from a chosen node in a linear graph, run N diffusion steps, and visualize concentration bars per node
21
- - **Tab 2 β€” Topologies**: Choose from Linear, Star, Ring, Grid (2Γ—3), or Binary Tree graphs and see how topology shapes the gradient
22
- - **Tab 3 β€” Competing Sources**: Place two different morphogens at different nodes and observe overlapping gradients
23
 
24
  ## How It Works
25
 
26
- `DiffusionField` manages a graph of nodes connected by edges. `MorphogenSource` objects emit at fixed rates. Each step: (1) emit, (2) diffuse β€” a fraction flows to neighbors, (3) decay β€” concentrations degrade, (4) clamp β€” cap at 1.0, snap near-zero to 0. `get_local_gradient()` bridges each node's concentrations to the `MorphogenGradient` API for agent-level strategy hints.
27
 
28
- [GitHub](https://github.com/coredipper/operon) | [PyPI](https://pypi.org/project/operon-ai/)
 
 
 
11
  short_description: Morphogen gradient formation on graph topologies
12
  ---
13
 
14
+ # 🌊 Diffusion -- Morphogen Gradient Visualizer
15
 
16
+ Simulate morphogen diffusion across graph topologies and watch concentration gradients form -- the spatial coordination layer that lets distributed agents sense their position.
17
 
18
+ ## What to Try
19
 
20
+ 1. Open the **Linear Chain** tab, set the **Source Node** and **Diffusion Steps** sliders, and click **Run Diffusion** to watch concentration spread from the source along a line of nodes.
21
+ 2. Switch to the **Topologies** tab and select different graph shapes (Star, Ring, Grid, Binary Tree) to see how network structure shapes gradient formation.
22
+ 3. In the **Competing Sources** tab, place two morphogens at different nodes and run diffusion to observe overlapping gradients and competition zones.
23
 
24
  ## How It Works
25
 
26
+ A DiffusionField manages a graph where MorphogenSource objects emit signals that spread to neighbors, decay over time, and clamp at saturation. Each node's local concentration maps to the MorphogenGradient API, giving agents position-aware strategy hints -- like how cells in a developing embryo read morphogen concentrations to determine their fate.
27
 
28
+ ## Learn More
29
+
30
+ [GitHub](https://github.com/coredipper/operon) | [PyPI](https://pypi.org/project/operon-ai/) | [Paper](https://github.com/coredipper/operon/tree/main/article)
requirements.txt CHANGED
@@ -1,2 +1,2 @@
1
  gradio>=4.0
2
- operon-ai>=0.14.0
 
1
  gradio>=4.0
2
+ operon-ai>=0.15.0