Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add Apache2.0 license, replace solarpy with pvlib (#16)
* add Apache2.0 license and mention it * clear up how our code relates to the sqlalchemy_schemadisplay project * remove unused code, fix typo * remove whitespace * add NOTICE mentioning Seita and the year development started * Typos. * remove appendix which deals with adding a notice to every file * add copyright owners and licenses for things in our sphinx theme * solar irradiation comparison script * Add credits to UI. Signed-off-by: F.N. Claessen <felix@seita.nl> * Fix use of solarpy. * Check solarpy for clear sky irradiance. Add location on southern hemisphere. * Black. * Update dependency replacing pyerf. * plot the outcomes of solar irradiation testing * add information about sunrise, noon and sunset * also plot dawn and dusk; remove flexmeasures dependency of test script * replace pysolar with pvlib to compute irradiation * update pre-commit repo tags * Distinguish between irradiance metrics. * Switch to empirically validated function. * Update links in Credits modal. * make main Readme more about general benefits, show pics and move installation and developer advice to other files * fix some links Co-authored-by: F.N. Claessen <felix@seita.nl>
- Loading branch information
Showing
19 changed files
with
606 additions
and
171 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
- [ ] I agree to contribute to the project under Apache 2 License. | ||
- [ ] To the best of my knowledge, the proposed patch is not based on a code under GPL or other license that is incompatible with FlexMeasures |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
# Developing for FlexMeasures | ||
|
||
Note: For developers, there is more detailed documentation available. Please consult the documentation next to the relevant code: | ||
|
||
* [General coding tips and maintenance](flexmeasures/Readme.md) | ||
* [Continuous Integration](ci/Readme.md) | ||
* [Database management](flexmeasures/data/Readme.md) | ||
* [API development](flexmeasures/api/Readme.md) | ||
|
||
|
||
## Virtual environment | ||
|
||
* Make a virtual environment: `python3.8 -m venv flexmeasures-venv` or use a different tool like `mkvirtualenv` or virtualenvwrapper. You can also use | ||
an [Anaconda distribution](https://conda.io/docs/user-guide/tasks/manage-environments.html) as base with `conda create -n flexmeasures-venv python=3.8`. | ||
* Activate it, e.g.: `source flexmeasures-venv/bin/activate` | ||
|
||
|
||
## Dependencies | ||
|
||
Install all dependencies including the ones needed for development: | ||
|
||
make install-for-dev | ||
|
||
## Run locally | ||
|
||
Now, to start the web application, you can run: | ||
|
||
python flexmeasures/run-local.py | ||
|
||
And access the server at http://localhost:5000 | ||
|
||
|
||
## Tests | ||
|
||
You can run automated tests with: | ||
|
||
make test | ||
|
||
which behind the curtains installs dependencies and calls pytest. | ||
|
||
A coverage report can be created like this: | ||
|
||
pytest --cov=flexmeasures --cov-config .coveragerc | ||
|
||
You can add --cov-report=html after which a htmlcov/index.html is generated. | ||
|
||
It's also possible to use: | ||
|
||
python setup.py test |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
# Building & Running FlexMeasures | ||
|
||
|
||
## Dependencies | ||
|
||
Install dependencies and the `flexmeasures` platform itself: | ||
|
||
make install | ||
|
||
## Configure environment | ||
|
||
* Set an env variable to indicate in which environment you are operating (one out of development|testing|staging|production), e.g.: | ||
|
||
`echo "FLASK_ENV=development" >> .env` | ||
|
||
`export FLASK_ENV=production` | ||
* If you need to customise settings, create `flexmeasures/<development|testing|staging|production>_config.py` and add required settings. | ||
If you're unsure what you need, just continue for now and the app will tell you what it misses. | ||
|
||
## Make a secret key for sessions | ||
|
||
mkdir -p /path/to/flexmeasures/instance | ||
head -c 24 /dev/urandom > /path/to/flexmeasures/instance/secret_key | ||
|
||
## Preparing the time series database | ||
|
||
* Make sure you have a Postgres (Version 9+) database. See `data/Readme.md` for instructions on this. | ||
* Tell `flexmeasures` about it. Either you are using the default for the environment you're in (see `flexmeasures/utils/config_defaults`), | ||
or you can configure your own connection string: In `flexmeasures/<development|testing|staging|production>_conf.py`, | ||
set the variable `SQLALCHEMY_DATABASE_URI = 'postgresql://<user>:<password>@<host-address>[:<port>]/<db>'` | ||
* Run `flask db upgrade` to create the Postgres DB structure. | ||
|
||
## Preparing the job queue database | ||
|
||
To let FlexMeasures queue forecasting and scheduling jobs, install a Redis server and configure access to it within FlexMeasures' config file (see above). You can find the default settings in `flexmeasures/utils/config_defaults.py`. | ||
|
||
TODO: more detail | ||
|
||
## Install an LP solver | ||
|
||
For planning balancing actions, the flexmeasures platform uses a linear program solver. Currently that is the Cbc solver. See the `FLEXMEASURES_LP_SOLVER` config setting if you want to change to a different solver. | ||
|
||
Installing Cbc can be done on Unix via: | ||
|
||
apt-get install coinor-cbc | ||
|
||
(also available in different popular package managers). | ||
|
||
We provide a script for installing from source (without requiring `sudo` rights) in [the CI Readme](ci/Readme.md). | ||
|
||
More information (e.g. for installing on Windows) on [the website](https://projects.coin-or.org/Cbc). | ||
|
||
|
||
## Run | ||
|
||
Now, to start the web application, you can run: | ||
|
||
python flexmeasures/run-local.py | ||
|
||
But in a production context, you shouldn't run a script - hand the `app` object to a WSGI process, as your platform of choice describes. | ||
|
||
Often, that requires a WSGI script. We provide an example WSGI script in [the CI Readme](ci/Readme.md). | ||
|
||
|
||
## Loading data | ||
|
||
If you have a SQL Dump file, you can load that: | ||
|
||
psql -U {user_name} -h {host_name} -d {database_name} -f {file_path} | ||
|
||
Else, you can populate some standard data, most of which comes from files: | ||
|
||
* Finally, run `flask db_populate --structure --data --small` to load this data into the database. | ||
The `--small` parameter will only load four assets and four days, so use this first to try things out. TODO: check which command is possible at the moment. Also add a TODO saying where we want to go with this (support for loading data). | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,174 @@ | ||
Apache License | ||
Version 2.0, January 2004 | ||
http://www.apache.org/licenses/ | ||
|
||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION | ||
|
||
1. Definitions. | ||
|
||
"License" shall mean the terms and conditions for use, reproduction, | ||
and distribution as defined by Sections 1 through 9 of this document. | ||
|
||
"Licensor" shall mean the copyright owner or entity authorized by | ||
the copyright owner that is granting the License. | ||
|
||
"Legal Entity" shall mean the union of the acting entity and all | ||
other entities that control, are controlled by, or are under common | ||
control with that entity. For the purposes of this definition, | ||
"control" means (i) the power, direct or indirect, to cause the | ||
direction or management of such entity, whether by contract or | ||
otherwise, or (ii) ownership of fifty percent (50%) or more of the | ||
outstanding shares, or (iii) beneficial ownership of such entity. | ||
|
||
"You" (or "Your") shall mean an individual or Legal Entity | ||
exercising permissions granted by this License. | ||
|
||
"Source" form shall mean the preferred form for making modifications, | ||
including but not limited to software source code, documentation | ||
source, and configuration files. | ||
|
||
"Object" form shall mean any form resulting from mechanical | ||
transformation or translation of a Source form, including but | ||
not limited to compiled object code, generated documentation, | ||
and conversions to other media types. | ||
|
||
"Work" shall mean the work of authorship, whether in Source or | ||
Object form, made available under the License, as indicated by a | ||
copyright notice that is included in or attached to the work | ||
(an example is provided in the Appendix below). | ||
|
||
"Derivative Works" shall mean any work, whether in Source or Object | ||
form, that is based on (or derived from) the Work and for which the | ||
editorial revisions, annotations, elaborations, or other modifications | ||
represent, as a whole, an original work of authorship. For the purposes | ||
of this License, Derivative Works shall not include works that remain | ||
separable from, or merely link (or bind by name) to the interfaces of, | ||
the Work and Derivative Works thereof. | ||
|
||
"Contribution" shall mean any work of authorship, including | ||
the original version of the Work and any modifications or additions | ||
to that Work or Derivative Works thereof, that is intentionally | ||
submitted to Licensor for inclusion in the Work by the copyright owner | ||
or by an individual or Legal Entity authorized to submit on behalf of | ||
the copyright owner. For the purposes of this definition, "submitted" | ||
means any form of electronic, verbal, or written communication sent | ||
to the Licensor or its representatives, including but not limited to | ||
communication on electronic mailing lists, source code control systems, | ||
and issue tracking systems that are managed by, or on behalf of, the | ||
Licensor for the purpose of discussing and improving the Work, but | ||
excluding communication that is conspicuously marked or otherwise | ||
designated in writing by the copyright owner as "Not a Contribution." | ||
|
||
"Contributor" shall mean Licensor and any individual or Legal Entity | ||
on behalf of whom a Contribution has been received by Licensor and | ||
subsequently incorporated within the Work. | ||
|
||
2. Grant of Copyright License. Subject to the terms and conditions of | ||
this License, each Contributor hereby grants to You a perpetual, | ||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable | ||
copyright license to reproduce, prepare Derivative Works of, | ||
publicly display, publicly perform, sublicense, and distribute the | ||
Work and such Derivative Works in Source or Object form. | ||
|
||
3. Grant of Patent License. Subject to the terms and conditions of | ||
this License, each Contributor hereby grants to You a perpetual, | ||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable | ||
(except as stated in this section) patent license to make, have made, | ||
use, offer to sell, sell, import, and otherwise transfer the Work, | ||
where such license applies only to those patent claims licensable | ||
by such Contributor that are necessarily infringed by their | ||
Contribution(s) alone or by combination of their Contribution(s) | ||
with the Work to which such Contribution(s) was submitted. If You | ||
institute patent litigation against any entity (including a | ||
cross-claim or counterclaim in a lawsuit) alleging that the Work | ||
or a Contribution incorporated within the Work constitutes direct | ||
or contributory patent infringement, then any patent licenses | ||
granted to You under this License for that Work shall terminate | ||
as of the date such litigation is filed. | ||
|
||
4. Redistribution. You may reproduce and distribute copies of the | ||
Work or Derivative Works thereof in any medium, with or without | ||
modifications, and in Source or Object form, provided that You | ||
meet the following conditions: | ||
|
||
(a) You must give any other recipients of the Work or | ||
Derivative Works a copy of this License; and | ||
|
||
(b) You must cause any modified files to carry prominent notices | ||
stating that You changed the files; and | ||
|
||
(c) You must retain, in the Source form of any Derivative Works | ||
that You distribute, all copyright, patent, trademark, and | ||
attribution notices from the Source form of the Work, | ||
excluding those notices that do not pertain to any part of | ||
the Derivative Works; and | ||
|
||
(d) If the Work includes a "NOTICE" text file as part of its | ||
distribution, then any Derivative Works that You distribute must | ||
include a readable copy of the attribution notices contained | ||
within such NOTICE file, excluding those notices that do not | ||
pertain to any part of the Derivative Works, in at least one | ||
of the following places: within a NOTICE text file distributed | ||
as part of the Derivative Works; within the Source form or | ||
documentation, if provided along with the Derivative Works; or, | ||
within a display generated by the Derivative Works, if and | ||
wherever such third-party notices normally appear. The contents | ||
of the NOTICE file are for informational purposes only and | ||
do not modify the License. You may add Your own attribution | ||
notices within Derivative Works that You distribute, alongside | ||
or as an addendum to the NOTICE text from the Work, provided | ||
that such additional attribution notices cannot be construed | ||
as modifying the License. | ||
|
||
You may add Your own copyright statement to Your modifications and | ||
may provide additional or different license terms and conditions | ||
for use, reproduction, or distribution of Your modifications, or | ||
for any such Derivative Works as a whole, provided Your use, | ||
reproduction, and distribution of the Work otherwise complies with | ||
the conditions stated in this License. | ||
|
||
5. Submission of Contributions. Unless You explicitly state otherwise, | ||
any Contribution intentionally submitted for inclusion in the Work | ||
by You to the Licensor shall be under the terms and conditions of | ||
this License, without any additional terms or conditions. | ||
Notwithstanding the above, nothing herein shall supersede or modify | ||
the terms of any separate license agreement you may have executed | ||
with Licensor regarding such Contributions. | ||
|
||
6. Trademarks. This License does not grant permission to use the trade | ||
names, trademarks, service marks, or product names of the Licensor, | ||
except as required for reasonable and customary use in describing the | ||
origin of the Work and reproducing the content of the NOTICE file. | ||
|
||
7. Disclaimer of Warranty. Unless required by applicable law or | ||
agreed to in writing, Licensor provides the Work (and each | ||
Contributor provides its Contributions) on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or | ||
implied, including, without limitation, any warranties or conditions | ||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A | ||
PARTICULAR PURPOSE. You are solely responsible for determining the | ||
appropriateness of using or redistributing the Work and assume any | ||
risks associated with Your exercise of permissions under this License. | ||
|
||
8. Limitation of Liability. In no event and under no legal theory, | ||
whether in tort (including negligence), contract, or otherwise, | ||
unless required by applicable law (such as deliberate and grossly | ||
negligent acts) or agreed to in writing, shall any Contributor be | ||
liable to You for damages, including any direct, indirect, special, | ||
incidental, or consequential damages of any character arising as a | ||
result of this License or out of the use or inability to use the | ||
Work (including but not limited to damages for loss of goodwill, | ||
work stoppage, computer failure or malfunction, or any and all | ||
other commercial damages or losses), even if such Contributor | ||
has been advised of the possibility of such damages. | ||
|
||
9. Accepting Warranty or Additional Liability. While redistributing | ||
the Work or Derivative Works thereof, You may choose to offer, | ||
and charge a fee for, acceptance of support, warranty, indemnity, | ||
or other liability obligations and/or rights consistent with this | ||
License. However, in accepting such obligations, You may act only | ||
on Your own behalf and on Your sole responsibility, not on behalf | ||
of any other Contributor, and only if You agree to indemnify, | ||
defend, and hold each Contributor harmless for any liability | ||
incurred by, or claims asserted against, such Contributor by reason | ||
of your accepting any such warranty or additional liability. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
FlexMeasures | ||
Copyright 2018 Seita Energy Flexibility | ||
Apache 2.0 license | ||
|
||
Sphinx RTD Theme (see documentation/_themes/sphinx_rtd_flexmeasures_theme) | ||
Copyright 2010-2021 Dave Snider, Read the Docs, Inc., FontAwesome, Łukasz Dziedzic, The Modernizr Team, Google Inc., Seita Energy Flexibility | ||
MIT license, BSD license, SIL Open Font license 1.1, Apache2.0 license |
Oops, something went wrong.