docs: improve README with usage instructions
Browse files- README.md +9 -7
- 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 |
-
|
| 17 |
|
| 18 |
-
##
|
| 19 |
|
| 20 |
-
|
| 21 |
-
|
| 22 |
-
|
| 23 |
|
| 24 |
## How It Works
|
| 25 |
|
| 26 |
-
Waveforms are computed mathematically
|
| 27 |
|
| 28 |
-
|
|
|
|
|
|
|
|
|
| 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.
|
|
|
|
| 1 |
gradio>=4.0
|
| 2 |
+
operon-ai>=0.15.0
|