Merge pull request #7 from codegreen-framework/main

doc test

Author: shubhvjain

.github/workflows/test.yml

@@ -0,0 +1,43 @@
+name: Run Tests on main
+
+# Trigger this workflow when pushing to the main branch
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+# Define the job to run the tests
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+    # Checkout the code from the repository
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Set up Python environment
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.12.5'  # Specify Python version (e.g., '3.9')
+
+    # Install dependencies (you can specify requirements.txt or pyproject.toml)
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install pytest pandas numpy entsoe-py redis tensorflow scikit-learn sphinx
+        pip install .
+      
+    # Run pytest to execute tests
+    - name: Generate .config file inside the test folder
+      run: |
+          echo "[codegreen]" > .codegreencore.config
+          echo "ENTSOE_token=${{ secrets.ENTSOE_TOKEN }}" >> .codegreencore.config
+          echo "enable_energy_caching=false" >> .codegreencore.config    
+    - name: Run tests
+      run: |
+        pytest

README.md

@@ -1 +1,21 @@
-The core business logic of codegreen. Please see the documentation website for more details about the project.
+[![Run Tests](https://github.com/codegreen-framework/codegreen-core/actions/workflows/test.yml/badge.svg)](https://github.com/codegreen-framework/codegreen-core/actions/workflows/test.yml)
+
+This repository contains the main functionality of the codegreen project. The complete documentation including installation and usage are available on the [documentation website](https://codegreen-framework.github.io/codegreen-core/). 
+
+## Development workflow 
+- the `release` branch contains the latest stable version of the released python package 
+- the `main` branch contains stable, tested code ready to be released. 
+- the `dev` branch is the main working branch. All feature branches are merged to `dev` 
+
+### Releasing  the package
+- Ensure new changes are merged to `dev` and the version number is bumped according to [sematic versioning](https://semver.org/).
+-  Merge `dev`to `main`. This should trigger tests.
+-  Create a git tag for the new version :
+```
+git checkout main
+git pull
+git tag vX.Y.Z  # Replace X.Y.Z with the new version number
+git push origin vX.Y.Z
+```
+- Create a PR from `main` to `release` and get one approval
+- Once the PR is merged, it will trigger the release of the new package version and publish the documentation.

codegreen_core/utilities/log.py

@@ -0,0 +1,24 @@
+# to log stuff
+
+from .config import Config
+from datetime import datetime
+import os
+import csv
+
+
+def time_prediction(data):
+  if Config.get("enable_time_prediction_logging")==True:
+    current_date = datetime.now()
+    file_name = f"{current_date.strftime('%B')}_{current_date.year}.csv"
+    file_location = os.path.join(Config.get("time_prediction_log_folder_path"), file_name)
+    file_exists = os.path.exists(file_location)
+    # Open the file in append mode
+    with open(file_location, mode='a', newline='') as file:
+        writer = csv.DictWriter(file, fieldnames=data.keys())
+        # If the file doesn't exist, write the header
+        if not file_exists:
+            writer.writeheader()
+        # Append the data to the file
+        writer.writerow(data)
+  else:
+    print("Logging not enabled")

docs/models.rst

@@ -1,3 +1,4 @@
+# this code is not yet used 
 from codegreen_core.models import predict
 from codegreen_core.data import energy
 from datetime import datetime

tests/test_predictions.py renamed to tests/test1_predictions.py

@@ -1,5 +1,6 @@
 import pytest
-from codegreen_core.data import entsoe,energy,carbon_intensity
+from codegreen_core.data import energy
+from codegreen_core.data.entsoe import renewableSources
 from codegreen_core.utilities.message import CodegreenDataError
 from datetime import datetime
 import pandas as pd
@@ -32,15 +33,15 @@ def test_entsoe_generation_data(self):
         "start":datetime(2024,2,1),
         "end":datetime(2024,2,2),
         "dtype": 'generation' ,
-        "file": "data/generation_DE_24_downloaded.csv",
+        "file": "tests/data/generation_DE_24_downloaded.csv",
         "interval60": False
       },
       {
         "country":"DE",
         "start":datetime(2024,3,20),
         "end":datetime(2024,3,24),
         "dtype": 'generation' ,
-        "file": "data/generation_DE_24_downloaded.csv",
+        "file": "tests/data/generation_DE_24_downloaded.csv",
         "interval60": False
       },
       # {
@@ -57,15 +58,15 @@ def test_entsoe_generation_data(self):
         "start":datetime(2024,3,20),
         "end":datetime(2024,3,24),
         "dtype": 'generation' ,
-        "file": "data/generation_GR_24_downloaded.csv",
+        "file": "tests/data/generation_GR_24_downloaded.csv",
         "interval60": True
       },
       {
         "country":"GR",
         "start":datetime(2024,1,25),
         "end":datetime(2024,1,28),
         "dtype": 'generation' ,
-        "file": "data/generation_GR_24_downloaded.csv",
+        "file": "tests/data/generation_GR_24_downloaded.csv",
         "interval60": True
       }
 
@@ -84,7 +85,7 @@ def test_entsoe_generation_data(self):
         end_utc =  pd.to_datetime(case["end"]) #case["end"].astimezone(pd.Timestamp.now(tz='UTC').tzinfo) if case["end"].tzinfo is None else case["end"]
         filtered_df = data_verify[(data_verify['start_date'] >= start_utc) & (data_verify['start_date'] < end_utc)]
         allCols = data.columns.tolist()
-        renPresent = list(set(allCols).intersection(entsoe.renewableSources))
+        renPresent = list(set(allCols).intersection(renewableSources))
         for e in renPresent:
           difference = filtered_df[e+"  - Actual Aggregated [MW]"] - data[e]
           sum_of_differences = difference.sum()

tests/test_data.py

@@ -10,7 +10,7 @@ def test_location_now():
 # test_location_now()
 
 def fetch_data(month_no,countries):
-  data = pd.read_csv("data/prediction_testing_data.csv")
+  data = pd.read_csv("tests/data/prediction_testing_data.csv")
   forecast_data = {}
   for c in countries:
     filter = data["file_id"] == c+""+str(month_no)
@@ -40,4 +40,4 @@ def test_locations():
     a,b,c,d = predict_optimal_location(data,case["h"],case["m"],case["p"],end,start)
     print(a,b,c,d)
 
-test_locations()
+# test_locations()

tests/test_loadshift_location.py

@@ -1,4 +1,3 @@
-import codegreen_core.tools as tools
 import pytest
 from codegreen_core.utilities.message import CodegreenDataError,Message
 from datetime import datetime,timezone,timedelta
@@ -69,13 +68,13 @@ def test_less_energy_data(self):
 
   def test_if_incorrect_data_provided(self):
     """this is to test if  energy data provided does not contain the data for the request time """
-    data = pd.read_csv("data/DE_forecast1.csv")
+    data = pd.read_csv("tests/data/DE_forecast1.csv")
     timestamp, message, average_percent_renewable = ts.predict_optimal_time(data,20,0,10,self.hard_finish_time_2,self.request_time_2)
     assert timestamp == int(self.request_time_2.timestamp())
     assert message == Message.NO_DATA
 
   def test_multiple(self):
-    data = pd.read_csv("data/DE_forecast1.csv")
+    data = pd.read_csv("tests/data/DE_forecast1.csv")
     hard_finish_time = datetime(2024,1,7,0,0)
     request_time = datetime(2024,1,5,0,0)
     cases = [
@@ -179,17 +178,17 @@ def test_data_validation_country(self):
     print(timestamp1,timestamp, message)
     assert timestamp - timestamp1 <= 10 
     assert message ==  Message.ENERGY_DATA_FETCHING_ERROR
-  def test_all_country_test(self):
-    test_cases = pd.read_csv("./data/test_cases_time.csv")
-    data = pd.read_csv("./data/prediction_testing_data.csv")
-    for index, row in test_cases.iterrows():
-      edata_filter = data["file_id"] == row["country"]
-      energy_data = data[edata_filter].copy()
-      start = datetime.strptime(row["start_time"], '%Y-%m-%d %H:%M:%S')
-      end = (start + timedelta(hours=row["hard_deadline_hour"]))
-      a,b,c = ts.predict_optimal_time(energy_data,row["runtime_hour"],row["runtime_min"],row["percent_renewable"],end,start)
-      print(a,b,c)
-      assert int(a) ==  row["expected_timestamp"]
+  # def test_all_country_test(self):
+  #   test_cases = pd.read_csv("./data/test_cases_time.csv")
+  #   data = pd.read_csv("./data/prediction_testing_data.csv")
+  #   for index, row in test_cases.iterrows():
+  #     edata_filter = data["file_id"] == row["country"]
+  #     energy_data = data[edata_filter].copy()
+  #     start = datetime.strptime(row["start_time"], '%Y-%m-%d %H:%M:%S')
+  #     end = (start + timedelta(hours=row["hard_deadline_hour"]))
+  #     a,b,c = ts.predict_optimal_time(energy_data,row["runtime_hour"],row["runtime_min"],row["percent_renewable"],end,start)
+  #     print(a,b,c)
+  #     assert int(a) ==  row["expected_timestamp"]
 
     # for case in cases:
     #   #print(case)
@@ -201,8 +200,8 @@ def test_all_country_test(self):
 
 # test if request time is none current time is being used 
 def test_all_country():
-    test_cases = pd.read_csv("./data/test_cases_time.csv")
-    data = pd.read_csv("./data/prediction_testing_data.csv")
+    test_cases = pd.read_csv("tests/data/test_cases_time.csv")
+    data = pd.read_csv("tests/data/prediction_testing_data.csv")
     for _ , row in test_cases.iterrows():
       print(row)
       edata_filter = data["file_id"] == row["country"]
@@ -218,7 +217,7 @@ def test_all_country():
       assert int(a) ==  row["expected_timestamp"]
       print("====")
 
-test_all_country()
+# test_all_country()
 
 
 # def data_validation_country():