Getting Started with Myome
Joe Scanlin
November 2025
This section provides practical guidance for implementing Myome. You'll learn about the core components (data ingestion, time-series database, analytics engine, web dashboard), system requirements, quick-start installation, how to add new sensors, and data export options for portability.
Myome is designed as a modular, extensible open-source platform. The reference implementation comprises:
# Clone repository
git clone https://github.com/myome/myome-core.git
cd myome-core
# Install dependencies
pip install -r requirements.txt
npm install
# Initialize local database
python scripts/init_database.py
# Start services
docker-compose up
# Access dashboard at http://localhost:3000
To integrate a new sensor or testing service, implement the HealthSensor interface:
# myome/sensors/new_device.py
from myome.core import HealthSensor, Measurement, SensorType
class NewDeviceAdapter(HealthSensor):
type = SensorType.HEART_RATE # or appropriate type
def __init__(self, api_key):
self.api_key = api_key
self.client = NewDeviceAPI(api_key)
async def connect(self):
await self.client.authenticate()
async def stream_data(self):
async for reading in self.client.stream():
yield Measurement(
timestamp=reading.time,
value=reading.hr,
unit='bpm',
confidence=0.95 # device-specific
)
async def get_historical(self, start, end):
return await self.client.query(start, end)
Myome prioritizes data portability to prevent vendor lock-in: