coredipper commited on
Commit
4bc20c9
·
verified ·
1 Parent(s): c43e580

docs: improve README with usage instructions

Browse files
Files changed (2) hide show
  1. README.md +9 -7
  2. requirements.txt +1 -1
README.md CHANGED
@@ -13,16 +13,18 @@ short_description: Biological oscillator patterns and waveform visualization
13
 
14
  # 🔃 Biological Oscillator Patterns
15
 
16
- Compute and visualize oscillator waveforms (sine, square, sawtooth, triangle, pulse) with damping, plus explore biological oscillator phase structures.
17
 
18
- ## Features
19
 
20
- - **Tab 1 Waveform Explorer**: 5 waveform types with configurable frequency, amplitude, damping, and cycles
21
- - **Tab 2 Biological Oscillators**: Circadian (day/night), Heartbeat (BPM), and Cell Cycle (G1/S/G2/M) phase breakdowns
22
- - **8 presets**: Sine wave, square pulse, damped sine, fast triangle, sawtooth, circadian, heartbeat, cell division
23
 
24
  ## How It Works
25
 
26
- Waveforms are computed mathematically (matching `oscillator.py` internals) without starting background threads. Biological oscillators show phase structures that map to real-world patterns like circadian rhythms and cell division cycles.
27
 
28
- [GitHub](https://github.com/coredipper/operon) | [PyPI](https://pypi.org/project/operon-ai/)
 
 
 
13
 
14
  # 🔃 Biological Oscillator Patterns
15
 
16
+ Visualize oscillator waveforms and biological phase structures -- the timing mechanisms that drive periodic maintenance, heartbeat monitoring, and cell cycle control in Operon agents.
17
 
18
+ ## What to Try
19
 
20
+ 1. Open the **Waveform Explorer** tab, select a waveform type from the dropdown (Sine, Square, Sawtooth, Triangle, or Pulse), adjust **Frequency**, **Amplitude**, and **Damping** sliders, and click **Generate** to see the waveform.
21
+ 2. Try the "Damped sine" preset to see how oscillations decay over time, or "Fast triangle" for rapid cycling.
22
+ 3. Switch to the **Biological Oscillators** tab and explore Circadian (day/night phases), Heartbeat (BPM-based), and Cell Cycle (G1/S/G2/M phase breakdowns) patterns.
23
 
24
  ## How It Works
25
 
26
+ Waveforms are computed mathematically from sine-based functions with configurable damping. Biological oscillators map these waveforms to real-world phase structures -- circadian rhythms, heartbeat intervals, and cell division cycles -- providing the timing backbone for Operon's scheduled maintenance and lifecycle management.
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