Skip to content

Commit aea69b5

Browse files
committed
merge: finalize merge before pushing
2 parents d4268df + f12a958 commit aea69b5

1 file changed

Lines changed: 39 additions & 4 deletions

File tree

README.md

Lines changed: 39 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -72,26 +72,33 @@ Whether you are exploring identity‑based AI behavior, governed reasoning, mult
7272
# **How to Implement the U.F.O. Architecture**
7373

7474
### **1. Clone the Repository**
75+
7576
Use Git to pull the full codebase locally:
77+
7678
```bash
7779
git clone https://github.com/dfeen87/ufo.git
7880
cd ufo
7981
```
8082

8183
### **2. Install Dependencies**
84+
8285
Install the required Python packages:
86+
8387
```bash
8488
pip install -r requirements.txt
8589
```
8690

8791
### **3. Install the U.F.O. Package (Required for Examples & CLI)**
92+
8893
Because the architecture is a structured Python package, install it in editable mode:
94+
8995
```bash
9096
pip install -e .
9197
```
9298
This ensures `radial_membrane_ai` is discoverable by Python and allows the example scripts and CLI to run correctly.
9399

94100
## **4. Explore the Core Modules**
101+
95102
The architecture is organized into clear modules:
96103

97104
- **radial_membrane_ai/core** — membrane geometry, behavioral strings, V‑Channels
@@ -105,12 +112,15 @@ The architecture is organized into clear modules:
105112
Each module is documented and designed for extension.
106113

107114
## **5. Run the Example Simulation**
115+
108116
A starter simulation is included:
117+
109118
```bash
110119
python examples/run_simulation.py
111120
```
112121

113122
You can also run the simulation modules directly:
123+
114124
```bash
115125
python -m radial_membrane_ai.simulation
116126
```
@@ -121,23 +131,48 @@ python -m radial_membrane_ai.multi_agent.simulation
121131

122132
These demonstrate membrane activation, agent interaction, stability‑metric enforcement, and basic governed reasoning flow.
123133

134+
## **6. Install Poetry (Required for CLI Execution)**
135+
136+
U.F.O. uses Poetry to expose the `ufo` command‑line interface.
137+
138+
Install Poetry using the official installer:
139+
140+
```bash
141+
curl -sSL https://install.python-poetry.org | python3 -
142+
```
143+
144+
After installation, ensure Poetry is on your PATH:
145+
146+
```bash
147+
export PATH="$HOME/.local/bin:$PATH"
148+
```
149+
150+
Then verify:
151+
152+
```bash
153+
poetry --version
154+
```
155+
Install the project inside Poetry’s virtual environment:
124156

125-
## **6. Run U.F.O. from the Terminal (CLI)**
126-
The U.F.O. governed runtime includes a dynamic terminal interface for running simulations interactively.
157+
```bash
158+
poetry install
159+
```
160+
Once Poetry is installed, the U.F.O. CLI can be run with:
127161

128-
### **Basic Usage**
129-
Single‑agent mode:
130162
```bash
131163
poetry run ufo --single
132164
```
133165

134166
Multi‑agent mode:
167+
135168
```bash
136169
poetry run ufo --multi
137170
```
138171

139172
### **Custom Execution**
173+
140174
You can customize governed runs with:
175+
141176
```bash
142177
poetry run ufo --steps 20 --excitation 0.3 --task-value 0.5 --visualize
143178
```

0 commit comments

Comments
 (0)