Getting started
Get in touch
FlexMeasures Changelog

Features

Scheduling
Forecasting
Reporting
Automations

Tutorials

Toy example: Introduction and setup
Toy example I: Scheduling a battery, from scratch
Toy example II: Adding solar production, and a limit on the grid connection
Toy example III: PV curtailment an Multi-asset scheduling
A flex-modeling tutorial for storage: Vehicle-to-grid
A flex-modeling tutorial for storage: Multiple feeds into shared storage
A flex-modeling tutorial for storage: Multiple commodities (gas & electricity)
Toy example IV: Computing schedules for processes
Toy example V: Computing reports
Toy example VI: Intermediate power constraints (groups)
Ingesting data from files and scripts
Forecasting & scheduling
Building custom UIs

Concepts

Energy flexibility
The FlexMeasures data model
Time series, events and beliefs
Data pipelining
Flexibility configuration
Security aspects
Commitments
Device scheduler: mixed-integer linear model
Annotations

The in-built UI

Dashboard
Assets
Sensors
Account overview
Administration

The API

API Introduction
Notation
Version 3.0
UI-support endpoints
API change log

The CLI

CLI Commands
FlexMeasures CLI Changelog

Hosting FlexMeasures

Installation & First steps
Running via Docker
Postgres database
How to deploy FlexMeasures
Multi-tenancy
Plans and rate-limiting
Configuration
White-labeling FlexMeasures
Redis Queues
Error monitoring
Modes

Creating plugins

Writing Plugins
Plugin showcase
Plugin Customization
Storing connection secrets

For developers

Why FlexMeasures adds value for software developers
Scripting FlexMeasures
Running a complete stack with docker-compose
Developing for FlexMeasures
Continuous integration
Custom authorization
Dependency Management
Developing on the API
Connection secrets
Automate deployment via Github actions and Git
Release process

Code Documentation

flexmeasures.api
flexmeasures.app
flexmeasures.auth
flexmeasures.cli
flexmeasures.data
flexmeasures.ui
flexmeasures.utils

FlexMeasures

flexmeasures.api
flexmeasures.api.v3_0
flexmeasures.api.v3_0.health
View page source

flexmeasures.api.v3_0.health

Classes

class flexmeasures.api.v3_0.health.HealthAPI

is_ready()

Previous Next

© Copyright 2026, Seita Energy Flexibility, developed in partnership with A1 Engineering, South Korea.

Built with Sphinx using a theme provided by Read the Docs.