echo-energycalc¶

Package that implement all energy related calculations. This covers power curve fitting and energy estimation, but goes beyond estimating electrical losses, implementing filters, etc.

The name of the package goes toward energy calculations only but it evolved to be a general calculation package, so it's not only about energy anymore.

Installation¶

This package can be installed using pip by following the latest instructions on the main README of the Performance Echo organization in GitHub.

Documentation¶

The documentation of this module is available at echo-energycalc.pages.dev. It uses the mkdocs tool alongside mkdocs-material and mkdocstrings to generate a static website with all the information needed to use the package. All relevant configuration files are present in mkdocs.yml and the documentation files are in the docs folder.

To see the documentation while developing the package, run the command below and open the browser at the address http://localhost:8111. You can change the port if needed.

mkdocs serve -a localhost:8111

When pushing changes to the repository, the documentation will be automatically updated in Cloudfare Pages due to the connection configured in Cloudflare. This way, you don't need to worry about updating the documentation when pushing changes to the repository. The process of configuring the connection in Cloudflare Pages is explained in this link, but there are details were considered:

The deployment uses Cloudflare credentials bruno.macedo@echoenergia.com.br and 1cY&l@EZTx6e9d.
Add the requirements-cloudflare.txt file to the repository, containing the dependencies needed to build the documentation
Change the build command to pip install -r requirements-cloudflare.txt && mkdocs build
To avoid Cloudflare trying to install the requirements from the requirements.txt file, you should add environment variable SKIP_DEPENDENCY_INSTALL with the value 1 to the build settings.
Add the values below in the extra field of the mkdocs.yml file to avoid the page being indexed by search engines like Google and Bing.

```yaml extra: meta: - name: robots content: noindex
Specify the Python version to be used in the Cloudflare Pages build settings by adding .python-version file to the root of the repository. Don't forget to remove any mentions to this file in .gitignore file.

Pytest¶

Configuration¶

To tell VS Code to use pytest as the testing framework, its recommended that you add the following configuration to the settings.json file in the .vscode folder of your project.

{
    "python.testing.pytestEnabled": true,
    "python.testing.unittestEnabled": false,
    "python.testing.autoTestDiscoverOnSaveEnabled": false,
}

Running Tests¶

Several pre-defined tests are configured in the tests/auto folder using pytest. There ae severeal ways to run these tests, like:

Using the command line, running:
```
pytest
```
Using the command line to run a specific test:
```
pytest -k <test_name>
```
Through the Visual Studio Code testing module. To do so, just open the icon on the left side of the screen that looks like a test tube and run or debug the tests using pytest.
Using the _run_pytest.py script, which is a convenience script that you can just run. In it you should specify the test you want to run. This is the best way to debug tests if you need to.

Warning

Keep in mind that the pre-configured tests in this file assumes that you have connectivity to the Performance server, so they will fail if you are not in Echo VPN.

Local installation¶

During development the package can be installed from the local repository using the command below.

uv pip install . --no-deps --reinstall --no-cache