Skip to content

Commit f4da66d

Browse files
authored
update the Readme (#2232)
Signed-off-by: Nicolas Höning <nicolas@seita.nl>
1 parent f6441c0 commit f4da66d

1 file changed

Lines changed: 14 additions & 7 deletions

File tree

README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ In a nutshell, FlexMeasures turns data into optimized schedules for flexible ass
1717

1818
![The most simple view of FlexMeasures, turning data into schedules](https://raw.githubusercontent.com/FlexMeasures/screenshots/main/architecture/simple-flexEMS.png)
1919

20+
FlexMeasures was created by and continues to be maintained by [Seita Energy Flexibility BV](https://www.seita.nl) in The Netherlands.
21+
The vision of the project is to make sure that smart backend software is available to all parties working with energy flexibility, no matter where they are working on their local energy transition.
2022

2123
Here is why using FlexMeasures is a great idea:
2224

@@ -40,7 +42,7 @@ FlexMeasures is designed to help with three basic needs of developers in the ene
4042
FlexMeasures is designed to make decisions based on data in an automated way. Data pipelining and dedicated machine learning tooling is crucial.
4143

4244
- API/CLI functionality to read in time series data
43-
- Extensions for integrating 3rd party data, e.g. from [ENTSO-E](https://github.com/SeitaBV/flexmeasures-entsoe) or [OpenWeatherMap](https://github.com/SeitaBV/flexmeasures-openweathermap)
45+
- Extensions/Plugins for integrating 3rd party data (e.g. from [ENTSO-E](https://github.com/SeitaBV/flexmeasures-entsoe), [OpenWeatherMap/WeatherAPI](https://github.com/flexmeasures/flexmeasures-weather)) or protocols (e.g. [OpenADR](https://github.com/FlexMeasures/flexmeasures-openadr3))
4446
- Forecasting for the upcoming hours
4547
- Schedule optimization for flexible assets
4648

@@ -63,23 +65,28 @@ Building customer-facing apps & services is where developers make impact. We mak
6365

6466
- FlexMeasures has well-documented API endpoints and CLI commands to interact with its model and data
6567
- You can extend it easily with your own logic by writing plugins
66-
- A backend UI shows you your assets in maps and your data in plots. There is also support for plots to be available per API, for integration in your own frontend
68+
- A backend UI shows you your assets in maps and your data in plots (try the Replay button!). There is also support for plots to be available per API, for integration in your own frontend
6769
- Multi-tenancy ― model multiple accounts on one server. Data is only seen/editable by authorized users in the right account
6870

6971

7072
## Getting started
7173

72-
Head over to our [documentation](https://flexmeasures.readthedocs.io), e.g. the [getting started guide](https://flexmeasures.readthedocs.io/latest/getting-started.html#getting-started) or the [5-minute tutorial](https://flexmeasures.readthedocs.io/latest/tut/toy-example-setup.html). Or find more information on [FlexMeasures.io](https://flexmeasures.io).
74+
Head over to our [documentation](https://flexmeasures.readthedocs.io), e.g. the [getting-started guide](https://flexmeasures.readthedocs.io/latest/getting-started.html#getting-started) or the [5-minute tutorial](https://flexmeasures.readthedocs.io/latest/tut/toy-example-setup.html). Or find more information on [FlexMeasures.io](https://flexmeasures.io).
7375

7476
See also [Seita's Github profile](https://github.com/SeitaBV), e.g. for FlexMeasures plugin examples.
7577

7678

7779
## Development & community
7880

79-
FlexMeasures was initiated by [Seita BV](https://www.seita.nl) in The Netherlands in order to make sure that smart backend software is available to all parties working with energy flexibility, no matter where they are working on their local energy transition.
81+
FlexMeasures is available under the permissive Apache2.0 licence and it is [an incubation project at the Linux Energy Foundation](https://www.lfenergy.org/projects/flexmeasures/).
8082

81-
We made FlexMeasures freely available under the Apache2.0 licence and it is now [an incubation project at the Linux Energy Foundation](https://www.lfenergy.org/projects/flexmeasures/).
83+
Within the FlexMeasures project, [we welcome contributions](https://github.com/FlexMeasures/tsc/blob/main/CONTRIBUTING.md). A list of contributing organizations:
8284

83-
Within the FlexMeasures project, [we welcome contributions](https://github.com/FlexMeasures/tsc/blob/main/CONTRIBUTING.md). You can also [learn more about our governance](https://github.com/Flexmeasures/tsc/blob/main/GOVERNANCE.md).
85+
- Seita Energy Flexibility (NL, maintainer)
86+
- Thiink (US)
87+
- ELaad (NL)
88+
- LUO (BE)
8489

85-
You can connect with the community here on GitHub (e.g. by creating an issue), on [the mailing list](https://lists.lfenergy.org/g/flexmeasures), on [the FlexMeasures channel within the LF Energy Slack](https://slack.lfenergy.org/) or [by contacting the current maintainers](https://seita.nl/who-we-are/#contact).
90+
You can also [learn more about our governance](https://github.com/Flexmeasures/tsc/blob/main/GOVERNANCE.md).
91+
92+
You can connect with the community here on GitHub (e.g. by creating an issue), on [the FlexMeasures channel within the LF Energy Slack](https://slack.lfenergy.org/), on [the mailing list](https://lists.lfenergy.org/g/flexmeasures) or [by contacting the current maintainers](https://seita.nl/who-we-are/#contact).

0 commit comments

Comments
 (0)