Getting started

FlexMeasures is useful from different perspectives. The documentation is quote vast, so we give you some pointers here what to read first, based on your perspective.

Using FlexMeasures

You are connecting to a running FlexMeasures server, e.g. for sending data, getting schedules or administrate users and assets.

First, you’ll need an account from the party running the server. Also, you probably want to:

• Look at the UI, e.g. pages for Dashboard and Administration.

• Read the API Introduction.

• Learn how to interact with the API in Posting data.

Hosting FlexMeasures

You want to run your own FlexMeasures instance, to offer services or for trying it out. You’ll want to:

• Have a first playful scheduling session, following Toy example: Scheduling a battery, from scratch.

• Get real with the tutorial on Installation & First steps.

• Discover the power of CLI Commands.

• Understand how to How to deploy FlexMeasures.

Plugin developers

You want to extend the functionality of FlexMeasures, e.g. a custom integration or a custom algorithm:

• Read the docs on Writing Plugins.

• See how some existing plugins are made flexmeasures-entsoe or flexmeasures-openweathermap

• Of course, some of the developers resources (see below) might be helpful to you, as well.

Warning

Please read A note on the ongoing data model transition.

Core developers

You want to help develop FlexMeasures, e.g. to fix a bug. We provide a getting-started guide to becoming a developer at Developing for FlexMeasures.