Getting started
Get in touch
FlexMeasures Changelog

Features

Scheduling
Forecasting
Reporting

Tutorials

Toy example: Introduction and setup
Toy example I: Scheduling a battery, from scratch
Toy example II: Adding solar production and limited grid connection
A flex-modeling tutorial for storage: Vehicle-to-grid
Toy example III: Computing schedules for processes
Toy example IV: Computing reports
Posting data
Forecasting & scheduling
Building custom UIs

Concepts

Energy flexibility
The FlexMeasures data model
Security aspects
Storage device scheduler: Linear model

The in-built UI

Dashboard
Assets
Sensors
Account overview
Administration

The API

API Introduction
Notation
Version 3.0
Developer API
API change log

The CLI

CLI Commands
FlexMeasures CLI Changelog

Hosting FlexMeasures

Installation & First steps
Running via Docker
Postgres database
How to deploy FlexMeasures
Configuration
White-labeling FlexMeasures
Redis Queues
Error monitoring
Modes

Developing Plugins

Writing Plugins
Plugin showcase
Plugin Customization

Developing on FlexMeasures

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

Code Documentation

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

FlexMeasures

flexmeasures.data
flexmeasures.data.queries
flexmeasures.data.queries.users
View page source

flexmeasures.data.queries.users

Functions

flexmeasures.data.queries.users.query_users_by_search_terms(search_terms: list[str] | None, filter_statement: bool = True) → Select

Previous Next

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

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