Challenge Submission by Irvin Heslan

Dockerfile

@@ -0,0 +1,17 @@
+# Use Python 3.8 slim image as base
+FROM python:3.12-slim
+WORKDIR /app
+COPY requirements.txt .
+
+RUN pip install --no-cache-dir -r requirements.txt
+COPY . .
+
+ENV DOCKER_ENV=1
+ENV CONFIG=config.yml
+ENV API_PROTOCOL=http
+ENV API_HOST=0.0.0.0
+ENV API_PORT=8888
+ENV API_ENDPOINT=productionplan
+EXPOSE 8888
+
+CMD ["python", "main.py"]

PROJECT_DESC.md

@@ -0,0 +1,99 @@
+# powerplant-coding-challenge
+
+
+## Welcome !
+
+Below you can find the description of a coding challenge that we ask people to perform when applying for a job in our team.
+
+The goal of this coding challenge is to provide the applicant some insight into the business we're in and as such provide the applicant an indication about the challenges she/he will be confronted with. Next, during the first interview we will use the applicant's implementation as a seed to discuss all kinds of interesting software engineering topics.  
+
+Time is scarce, we know. Therefore we ask you not to spend more than 4 hours on this challenge. We know it is not possible to deliver a finished implementation of the challenge in only four hours. Even though your submission will not be complete, it will provide us plenty of information and topics to discuss later on during the talks.
+
+This coding-challenge is part of a formal process and is used in collaboration with the recruiting companies we work with.  Submitting a pull-request will not automatically trigger the recruitement process.
+## Who are we 
+
+We are the IS team of the 'Short-term Power as-a-Service' (a.k.a. SPaaS) team within [GEM](https://gems.engie.com/).
+
+[GEM](https://gems.engie.com/), which stands for 'Global Energy Management', is the energy management arm of [ENGIE](https://www.engie.com/), one of the largest global energy players, 
+with access to local markets all over the world.  
+
+SPaaS is a team consisting of around 100 people with experience in energy markets, IT and modeling. In smaller teams consisting of a mix of people with different experiences, we are active on the [day-ahead](https://en.wikipedia.org/wiki/European_Power_Exchange#Day-ahead_markets) market, [intraday markets](https://en.wikipedia.org/wiki/European_Power_Exchange#Intraday_markets) and [collaborate with the TSO to balance the grid continuously](https://en.wikipedia.org/wiki/Transmission_system_operator#Electricity_market_operations).
+
+## The challenge
+
+### In short
+Calculate how much power each of a multitude of different [powerplants](https://en.wikipedia.org/wiki/Power_station) need to produce (a.k.a. the production-plan) when the [load](https://en.wikipedia.org/wiki/Load_profile) is given and taking into account the cost of the underlying energy sources (gas,  kerosine) and the Pmin and Pmax of each powerplant.
+
+### More in detail
+
+The load is the continuous demand of power. The total load at each moment in time is forecasted. For instance for Belgium you can see the load forecasted by the grid operator [here](https://www.elia.be/en/grid-data/load-and-load-forecasts).
+
+At any moment in time, all available powerplants need to generate the power to exactly match the load.  The cost of generating power can be different for every powerplant and is dependent on external factors: The cost of producing power using a [turbojet](https://en.wikipedia.org/wiki/Gas_turbine#Industrial_gas_turbines_for_power_generation), that runs on kerosine, is higher compared to the cost of generating power using a gas-fired powerplant because of gas being cheaper compared to kerosine and because of the [thermal efficiency](https://en.wikipedia.org/wiki/Thermal_efficiency) of a gas-fired powerplant being around 50% (2 units of gas will generate 1 unit of electricity) while that of a turbojet is only around 30%.  The cost of generating power using windmills however is zero. Thus deciding which powerplants to activate is dependent on the [merit-order](https://en.wikipedia.org/wiki/Merit_order).
+
+When deciding which powerplants in the merit-order to activate (a.k.a. [unit-commitment problem](https://en.wikipedia.org/wiki/Unit_commitment_problem_in_electrical_power_production)) the maximum amount of power each powerplant can produce (Pmax) obviously needs to be taken into account.  Additionally gas-fired powerplants generate a certain minimum amount of power when switched on, called the Pmin. 
+
+
+### Performing the challenge
+
+Build a REST API exposing an endpoint `/productionplan` that accepts a POST of which the body contains a payload as you can find in the `example_payloads` directory and that returns a json with the same structure as in `example_response.json` and that manages and logs run-time errors.
+
+For calculating the unit-commitment, we prefer you not to rely on an existing (linear-programming) solver but instead write an algorithm yourself.
+
+Implementations can be submitted in either C# (on .Net 5 or higher) or Python (3.8 or higher) as these are (currently) the main languages we use in SPaaS. Along with the implementation should be a README that describes how to compile (if applicable) and launch the application.
+
+- C# implementations should contain a project file to compile the application. 
+- Python implementations should contain a `requirements.txt` or a `pyproject.toml` (for use with poetry) to install all needed dependencies.
+
+#### Payload
+
+The payload contains 3 types of data:
+ - load: The load is the amount of energy (MWh) that need to be generated during one hour.
+ - fuels: based on the cost of the fuels of each powerplant, the merit-order can be determined which is the starting point for deciding which powerplants should be switched on and how much power they will deliver.  Wind-turbine are either switched-on, and in that case generate a certain amount of energy depending on the % of wind, or can be switched off. 
+   - gas(euro/MWh): the price of gas per MWh. Thus if gas is at 6 euro/MWh and if the efficiency of the powerplant is 50% (i.e. 2 units of gas will generate one unit of electricity), the cost of generating 1 MWh is 12 euro.
+   - kerosine(euro/Mwh): the price of kerosine per MWh.
+   - co2(euro/ton): the price of emission allowances (optionally to be taken into account).
+   - wind(%): percentage of wind. Example: if there is on average 25% wind during an hour, a wind-turbine with a Pmax of 4 MW will generate 1MWh of energy.
+ - powerplants: describes the powerplants at disposal to generate the demanded load. For each powerplant is specified:
+   - name:
+   - type: gasfired, turbojet or windturbine.
+   - efficiency: the efficiency at which they convert a MWh of fuel into a MWh of electrical energy. Wind-turbines do not consume 'fuel' and thus are considered to generate power at zero price.
+   - pmax: the maximum amount of power the powerplant can generate.
+   - pmin: the minimum amount of power the powerplant generates when switched on. 
+
+#### response
+
+The response should be a json as in `example_payloads/response3.json`, which is the expected answer for `example_payloads/payload3.json`, specifying for each powerplant how much power each powerplant should deliver. The power produced by each powerplant has to be a multiple of 0.1 Mw and the sum of the power produced by all the powerplants together should equal the load.
+
+### Want more challenge?
+
+Having fun with this challenge and want to make it more realistic. Optionally, do one of the extra's below:
+
+#### Docker
+
+Provide a Dockerfile along with the implementation to allow deploying your solution quickly.
+
+#### CO2
+
+Taken into account that a gas-fired powerplant also emits CO2, the cost of running the powerplant should also take into account the cost of the [emission allowances](https://en.wikipedia.org/wiki/Carbon_emission_trading).  For this challenge, you may take into account that each MWh generated creates 0.3 ton of CO2. 
+
+## Acceptance criteria
+
+For a submission to be reviewed as part of an application for a position in the team, the project needs to:
+  - contain a README.md explaining how to build and launch the API
+  - expose the API on port `8888`
+
+Failing to comply with any of these criteria will automatically disqualify the submission.
+
+## More info
+
+For more info on energy management, check out:
+
+ - [Global Energy Management Solutions](https://www.youtube.com/watch?v=SAop0RSGdHM)
+ - [COO hydroelectric power station](https://www.youtube.com/watch?v=edamsBppnlg)
+ - [Management of supply](https://www.youtube.com/watch?v=eh6IIQeeX3c) - video made during winter 2018-2019
+
+## FAQ
+
+##### Can an existing solver be used to calculate the unit-commitment
+Implementations should not rely on an external solver and thus contain an algorithm written from scratch (clarified in the text as of version v1.1.0)
+

README.md

@@ -1,99 +1,150 @@
-# powerplant-coding-challenge
+## Info
 
+powerplant-coding-challenge
+Submission by Irvin Heslan
 
-## Welcome !
+## Prerequisites
 
-Below you can find the description of a coding challenge that we ask people to perform when applying for a job in our team.
+- Python 3.8 or higher
+- Docker (optional)
 
-The goal of this coding challenge is to provide the applicant some insight into the business we're in and as such provide the applicant an indication about the challenges she/he will be confronted with. Next, during the first interview we will use the applicant's implementation as a seed to discuss all kinds of interesting software engineering topics.  
+## Installation
+### Local Installation
 
-Time is scarce, we know. Therefore we ask you not to spend more than 4 hours on this challenge. We know it is not possible to deliver a finished implementation of the challenge in only four hours. Even though your submission will not be complete, it will provide us plenty of information and topics to discuss later on during the talks.
+1. Clone the repository:
+```bash
+git clone 
+cd powerplant-coding-challenge
+```
 
-This coding-challenge is part of a formal process and is used in collaboration with the recruiting companies we work with.  Submitting a pull-request will not automatically trigger the recruitement process.
-## Who are we 
+2. Create a virtual environment (optional but recommended):
+```bash
+python -m venv venv
+source venv/bin/activate  # On Windows: venv\Scripts\activate
+```
 
-We are the IS team of the 'Short-term Power as-a-Service' (a.k.a. SPaaS) team within [GEM](https://gems.engie.com/).
+3. Install dependencies:
+```bash
+pip install -r requirements.txt
 
-[GEM](https://gems.engie.com/), which stands for 'Global Energy Management', is the energy management arm of [ENGIE](https://www.engie.com/), one of the largest global energy players, 
-with access to local markets all over the world.  
 
-SPaaS is a team consisting of around 100 people with experience in energy markets, IT and modeling. In smaller teams consisting of a mix of people with different experiences, we are active on the [day-ahead](https://en.wikipedia.org/wiki/European_Power_Exchange#Day-ahead_markets) market, [intraday markets](https://en.wikipedia.org/wiki/European_Power_Exchange#Intraday_markets) and [collaborate with the TSO to balance the grid continuously](https://en.wikipedia.org/wiki/Transmission_system_operator#Electricity_market_operations).
+### Docker Installation
 
-## The challenge
+1. Clone the repository:
+```bash
+git clone 
+cd powerplant-coding-challenge
+```
 
-### In short
-Calculate how much power each of a multitude of different [powerplants](https://en.wikipedia.org/wiki/Power_station) need to produce (a.k.a. the production-plan) when the [load](https://en.wikipedia.org/wiki/Load_profile) is given and taking into account the cost of the underlying energy sources (gas,  kerosine) and the Pmin and Pmax of each powerplant.
+2. Build the Docker image:
+```bash
+docker build -t powerplant-api .
+```
 
-### More in detail
+## Configuration
 
-The load is the continuous demand of power. The total load at each moment in time is forecasted. For instance for Belgium you can see the load forecasted by the grid operator [here](https://www.elia.be/en/grid-data/load-and-load-forecasts).
+The API configuration is stored by default in `config.yml`. Default settings:
 
-At any moment in time, all available powerplants need to generate the power to exactly match the load.  The cost of generating power can be different for every powerplant and is dependent on external factors: The cost of producing power using a [turbojet](https://en.wikipedia.org/wiki/Gas_turbine#Industrial_gas_turbines_for_power_generation), that runs on kerosine, is higher compared to the cost of generating power using a gas-fired powerplant because of gas being cheaper compared to kerosine and because of the [thermal efficiency](https://en.wikipedia.org/wiki/Thermal_efficiency) of a gas-fired powerplant being around 50% (2 units of gas will generate 1 unit of electricity) while that of a turbojet is only around 30%.  The cost of generating power using windmills however is zero. Thus deciding which powerplants to activate is dependent on the [merit-order](https://en.wikipedia.org/wiki/Merit_order).
+```yaml
+API:
+  protocol: http
+  host: 0.0.0.0
+  endpoint: productionplan
+  port: 8888
+```
 
-When deciding which powerplants in the merit-order to activate (a.k.a. [unit-commitment problem](https://en.wikipedia.org/wiki/Unit_commitment_problem_in_electrical_power_production)) the maximum amount of power each powerplant can produce (Pmax) obviously needs to be taken into account.  Additionally gas-fired powerplants generate a certain minimum amount of power when switched on, called the Pmin. 
+These settings can be overrided with Docker env variables.
+Env variables will ALWAYS override setting file.
 
+```
+ENV DOCKER_ENV=1
+ENV API_PROTOCOL=http
+ENV API_HOST=0.0.0.0
+ENV API_PORT=8888
+ENV API_ENDPOINT=productionplan
+EXPOSE 8888
+```
 
-### Performing the challenge
+or by setting up a custom config_file
+```
+ENV DOCKER_ENV=1
+ENV CONFIG=mycustom_config.yml
+```
 
-Build a REST API exposing an endpoint `/productionplan` that accepts a POST of which the body contains a payload as you can find in the `example_payloads` directory and that returns a json with the same structure as in `example_response.json` and that manages and logs run-time errors.
 
-For calculating the unit-commitment, we prefer you not to rely on an existing (linear-programming) solver but instead write an algorithm yourself.
 
-Implementations can be submitted in either C# (on .Net 5 or higher) or Python (3.8 or higher) as these are (currently) the main languages we use in SPaaS. Along with the implementation should be a README that describes how to compile (if applicable) and launch the application.
 
-- C# implementations should contain a project file to compile the application. 
-- Python implementations should contain a `requirements.txt` or a `pyproject.toml` (for use with poetry) to install all needed dependencies.
 
-#### Payload
+## Usage
 
-The payload contains 3 types of data:
- - load: The load is the amount of energy (MWh) that need to be generated during one hour.
- - fuels: based on the cost of the fuels of each powerplant, the merit-order can be determined which is the starting point for deciding which powerplants should be switched on and how much power they will deliver.  Wind-turbine are either switched-on, and in that case generate a certain amount of energy depending on the % of wind, or can be switched off. 
-   - gas(euro/MWh): the price of gas per MWh. Thus if gas is at 6 euro/MWh and if the efficiency of the powerplant is 50% (i.e. 2 units of gas will generate one unit of electricity), the cost of generating 1 MWh is 12 euro.
-   - kerosine(euro/Mwh): the price of kerosine per MWh.
-   - co2(euro/ton): the price of emission allowances (optionally to be taken into account).
-   - wind(%): percentage of wind. Example: if there is on average 25% wind during an hour, a wind-turbine with a Pmax of 4 MW will generate 1MWh of energy.
- - powerplants: describes the powerplants at disposal to generate the demanded load. For each powerplant is specified:
-   - name:
-   - type: gasfired, turbojet or windturbine.
-   - efficiency: the efficiency at which they convert a MWh of fuel into a MWh of electrical energy. Wind-turbines do not consume 'fuel' and thus are considered to generate power at zero price.
-   - pmax: the maximum amount of power the powerplant can generate.
-   - pmin: the minimum amount of power the powerplant generates when switched on. 
+### Running Locally
 
-#### response
+1. Start the API server:
+```bash
+python main.py
+```
 
-The response should be a json as in `example_payloads/response3.json`, which is the expected answer for `example_payloads/payload3.json`, specifying for each powerplant how much power each powerplant should deliver. The power produced by each powerplant has to be a multiple of 0.1 Mw and the sum of the power produced by all the powerplants together should equal the load.
+The API will be available at `http://localhost:8888`
 
-### Want more challenge?
+### Running with Docker
 
-Having fun with this challenge and want to make it more realistic. Optionally, do one of the extra's below:
+1. Run the container:
+```bash
+docker run -p 8888:8888 powerplant-api
+```
 
-#### Docker
+The API will be available at `http://localhost:8888`
 
-Provide a Dockerfile along with the implementation to allow deploying your solution quickly.
 
-#### CO2
+## API Endpoints
 
-Taken into account that a gas-fired powerplant also emits CO2, the cost of running the powerplant should also take into account the cost of the [emission allowances](https://en.wikipedia.org/wiki/Carbon_emission_trading).  For this challenge, you may take into account that each MWh generated creates 0.3 ton of CO2. 
+### GET /
+Returns a simple message directing users to use the POST endpoint.
 
-## Acceptance criteria
+### POST /productionplan
+Calculate the optimal production plan for power plants.
 
-For a submission to be reviewed as part of an application for a position in the team, the project needs to:
-  - contain a README.md explaining how to build and launch the API
-  - expose the API on port `8888`
+**Request Format:**
+```json
+{
+    "load": float,
+    "fuels": {
+        "gas": float,
+        "kerosine": float,
+        "co2": float,
+        "wind": float
+    },
+    "powerplants": [
+        {
+            "name": string,
+            "type": string,
+            "efficiency": float,
+            "pmin": int,
+            "pmax": int
+        }
+    ]
+}
+```
 
-Failing to comply with any of these criteria will automatically disqualify the submission.
+**Response Format:**
+```json
+{
+    "powerplant-1": float,
+    "powerplant-2": float,
+    ...
+}
+```
 
-## More info
+## Logging
 
-For more info on energy management, check out:
+All the logs file are in logs/folder if the folder is not existing it will create the folder logs.
+One log per day of run.
 
- - [Global Energy Management Solutions](https://www.youtube.com/watch?v=SAop0RSGdHM)
- - [COO hydroelectric power station](https://www.youtube.com/watch?v=edamsBppnlg)
- - [Management of supply](https://www.youtube.com/watch?v=eh6IIQeeX3c) - video made during winter 2018-2019
 
-## FAQ
+## Testing
 
-##### Can an existing solver be used to calculate the unit-commitment
-Implementations should not rely on an external solver and thus contain an algorithm written from scratch (clarified in the text as of version v1.1.0)
+To test the API with example payloads:
 
+```bash
+python ./tests/test.py
+```

config.yml

@@ -0,0 +1,5 @@
+API:
+  protocol: http
+  host: 0.0.0.0
+  endpoint: productionplan
+  port: 8888

core/__init__.py

@@ -0,0 +1,14 @@
+from core.api import productionApp
+from core.utils import get_config, load_config, format_payload
+from core.func import solve
+from core.classes import Fuels, Powerplant
+
+__all__ = [
+    'productionApp',
+    'get_config',
+    'load_config',
+    'format_payload',
+    'solve',
+    'Fuels',
+    'Powerplant'
+]