How andreaj42/cortexforge works
CorteXforge plans radio experiments, executes them on CorteXlab transmitter, receiver, and synchronization nodes, and provides a separate API/CLI for downloading pre-generated datasets. The main workflow is planner configuration → scenario and timeline generation → role-based Forge execution → labeled SigMF recordings. The graph also preserves the dataset-access and waveform-generation capabilities. Some subsystem relationships are documented in the README or SOURCE INDEX; unsampled internals are not assumed to call one another.
Main entry points: rx.py Receiver capture · planner/main.py Scenario orchestration · forge/main.py Role dispatcher · tx.py Transmitter
Components 27
Experiment planning
- Planner CLI
src/cortexforge/cli/planner.py - Scenario orchestration
src/cortexforge/planner/main.py - Timeline generator
src/cortexforge/planner/generators/experiment_scenario.py - Deployment scenario
src/cortexforge/planner/generators/cortexlab_scenario.py - Modulation definitions
src/cortexforge/modulations.py
Forge execution
- Forge CLI
src/cortexforge/cli/forge.py - Role dispatcher
src/cortexforge/forge/main.py - Sync coordinator
src/cortexforge/forge/sync.py - Sync barrier client
src/cortexforge/forge/utils/sync_barrier/sync_barrier_client.py - Sync barrier server
src/cortexforge/forge/utils/sync_barrier/sync_barrier_server.py
Radio and metadata
- Transmitter
src/cortexforge/forge/radio/tx.py - Waveform generation
src/cortexforge/forge/radio/waveforms_digital.py - Pulse shaping
src/cortexforge/forge/radio/pulse_shaping.py - Receiver capture
src/cortexforge/forge/radio/rx.py - GNU Radio recorder
src/cortexforge/forge/radio/rx_recorder.py - Power analysis
src/cortexforge/forge/utils/compute_baseline.py - SigMF annotations
src/cortexforge/forge/utils/sigmf/sigmf_annotations.py - SigMF writer
src/cortexforge/forge/utils/sigmf_writer.py - SigMF recordings
Dataset access
- Datasets CLI
src/cortexforge/datasets/main.py - Dataset API
src/cortexforge/datasets/api.py - Local dataset access
src/cortexforge/datasets/local.py - Dataset manifest
src/cortexforge/datasets/manifest.py - Dataset files
Other components
- Experiment user
- CorteXlab testbed
- Dataset user
Connections 31
- Experiment user → Planner CLI: configures
- Planner CLI → Scenario orchestration: parses arguments
src/cortexforge/planner/main.py - Scenario orchestration → Timeline generator: generates timeline
src/cortexforge/planner/main.py - Scenario orchestration → Deployment scenario: generates deployment
src/cortexforge/planner/main.py - Timeline generator → Modulation definitions: uses definitions
src/cortexforge/planner/generators/experiment_scenario.py - Scenario orchestration → CorteXlab testbed: targets deployment
- CorteXlab testbed → Forge CLI: runs node roles
- Forge CLI → Role dispatcher: parses arguments
src/cortexforge/forge/main.py - Role dispatcher → Transmitter: dispatches TX
src/cortexforge/forge/main.py - Role dispatcher → Receiver capture: dispatches RX
src/cortexforge/forge/main.py - Role dispatcher → Sync coordinator: dispatches sync
src/cortexforge/forge/main.py - Transmitter → Waveform generation: uses waveforms
src/cortexforge/forge/radio/tx.py - Waveform generation → Pulse shaping: uses shaping
src/cortexforge/forge/radio/waveforms_digital.py - Waveform generation → Modulation definitions: uses definitions
src/cortexforge/forge/radio/waveforms_digital.py - Receiver capture → GNU Radio recorder: records samples
src/cortexforge/forge/radio/rx.py - Receiver capture → Sync barrier client: registers and waits
src/cortexforge/forge/radio/rx.py - Transmitter → Sync barrier client: registers and waits
src/cortexforge/forge/radio/tx.py - Sync coordinator → Sync barrier server: runs barrier server
src/cortexforge/forge/sync.py - Sync barrier client → Sync barrier server: exchanges readiness
- Receiver capture → Power analysis: computes baseline
src/cortexforge/forge/radio/rx.py - Receiver capture → SigMF annotations: creates labels
src/cortexforge/forge/radio/rx.py - SigMF annotations → Power analysis: measures band power
src/cortexforge/forge/utils/sigmf/sigmf_annotations.py - Receiver capture → SigMF writer: writes metadata
src/cortexforge/forge/radio/rx.py - SigMF writer → SigMF recordings: writes recording files
- SigMF recordings → CorteXlab testbed: copies to shared storage
- Dataset user → Datasets CLI: lists or downloads
src/cortexforge/datasets/main.py - Datasets CLI → Dataset API: requests datasets
src/cortexforge/datasets/main.py - Dataset API → Local dataset access: uses local access
src/cortexforge/datasets/api.py - Dataset API → Dataset manifest: reads manifest
src/cortexforge/datasets/api.py - Local dataset access → Dataset manifest: uses manifest data
src/cortexforge/datasets/local.py - Local dataset access → Dataset files: installs datasets