readme

source/databricks/settlement_report/README.md

@@ -5,24 +5,32 @@
 
 ## Overview
 
-The folder contains all the relevant code for creating and testing the python wheel used in the Databricks environment for creating settlement reports.
+The `settlement_report` folder contains all the relevant code for creating and testing the python wheel, which is used in the Databricks Job(s) for creating settlement reports.
 
- The codebase is organized to facilitate development, testing, and deployment processes.
+The wheel's responsibility is to 
+- Create a csv files with results (and optionally basis data) from wholesale calculations or balance fixing calculations. 
+- Zip the csv files mentioned above
 
-## Directory Structure
+The wheel exposes a set of entry points that are used in the Databricks for creating the settlement reports.
 
+## Project Structure 
 
-The 'The project directory is organized as follows:
+The `settlement_report_job` contains the required code for creating the python wheel. The code is structured as follows:
 
-**domain/**:
+**entry_points/**:
 
-Contains the core business logic and rules. This folder is divided into subfolders - one for each type of settlement report data (e.g. metering point periods, time series points and energy results). Logic for generating and managing settlement reports is implemented here.
+Handles interactions with the outside world. It contains all the entry points and argument that the Databricks jobs/tasks use, and it is responsible for orchestrating the settlement report generation process.
 
-**entry_points/**:
+**domain/**:
+
+Contains the core business logic and rules. This folder is divided into subfolders: - one for each report type (e.g. metering point periods, time series points and energy results). Logic for preparing settlement reports data is implemented here. Here are some of the key responsibilities that is implemented for each type of settlement report data:
 
-Handles interactions with the outside world. It contains all the entry points that the Databricks jobs uses. And it is responsible for orchestrating the settlement report generation process.
+* filter input data based on the given parameters
+* transform the input data into the desired format for csv: columns, data types, ordering etc.
 
 **infrastructure/**: 
 
-Implementations for accessing and storing settlement data. This means things like accessing delta tables/view (repository), writing csv and generating the zip file.
-
+Implementations for accessing and storing data for settlement reports. This means things like accessing delta tables/view (repository), writing csv and generating the zip file.
+
+## Using the wheel in Databricks
+The intention of the wheel is to be used with Databricks tasks. There is an entry point for each report type and one for the zip file generation. The orchestration of Databricks tasks is done in dh3-infrastructure.