Added build script for building dlib and running pytests on push

Author: miriamkw

.github/workflows/ci.yml

@@ -0,0 +1,34 @@
+name: CI Workflow
+
+# Trigger the workflow on push and pull request events
+on:
+  push:
+  pull_request:
+
+# Define the jobs to run in the workflow
+jobs:
+  build-and-test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.9'  # Specify your required Python version
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+
+      - name: Run build script
+        run: |
+          chmod +x build.sh
+          ./build.sh
+
+      - name: Run tests
+        run: |
+          pytest

README.md

@@ -8,22 +8,8 @@ This is achieved by creating a foreign function interface (FFI) in Swift by usin
 
 ## Installation
 
-### TODO: Remove this and add examples with pypi / local builds instead
+### TODO: Add examples with pypi 
 
-1. Clone the repository
-2. Build the dynamic library:
-
-```
-swift package clean
-swift build --configuration release
-```
-Check if the dynamic library got properly generated and print the path:
-```
-find .build -name "libLoopAlgorithmToPython.dylib"
-```
-Output should be something like: /release/libLoopAlgorithmToPython.dylib
-
-Copy that file into your repository.
 
 
 ## Repository Overview
@@ -124,22 +110,182 @@ To do:
 - [X] write tests with example files
 - [ ] create pypi package
 - [ ] add a build script 
-  - automatically run tests on push 
-  - automatically build new dlib on push
+  - [ ] automatically run tests on push 
+  - [ ] automatically build new dlib on push
 - [X] clean up code swift
 - [X] clean up code python
 - [ ] update readme with new changes
-  - explanation, separating between python and swift code
-  - example usage of the api (with signal handlers), and example inputs (refer to test files)
-  - refer to example input files
+  - [X] explanation, separating between python and swift code
+  - [X] example usage of the api (with signal handlers), and example inputs (refer to test files)
+  - [X] refer to example input files
   - build, venv, run commands
   - pypi
-  - running tests
+  - [X] running tests
 - [ ] merge to main
 - [ ] next project: take a df as input, convert to json (or do it in tidepool study?)
 
 
 
+## Python API Functions
+
+-------------------------
+
+### Initialize Exception Handlers
+
+`initialize_exception_handlers()`
+
+Initializes the exception and signal handlers in the Swift library to provide more informative error messages.
+
+-------------------------
+
+### Generate Prediction
+
+`generate_prediction(json_file, len=72)`
+
+Generates a prediction based on the provided JSON input.
+
+- **Parameters**: 
+  - `json_file`: The JSON data input. See python tests and test files for example inputs.
+  - `len` (optional): The number of prediction values to generate. Defaults to 72.
+- **Returns**: A list of prediction values.
+
+-------------------------
+
+### Get Prediction Dates
+
+`get_prediction_dates(json_file)`
+
+Fetches prediction dates based on the provided JSON input.
+
+- **Parameters**: 
+  - `json_file`: The JSON data input. See python tests and test files for example inputs.
+- **Returns**: A list of prediction dates as strings.
+
+-------------------------
+
+### Get Prediction Values and Dates
+
+`get_prediction_values_and_dates(json_file)`
+
+Combines the `generate_prediction` and `get_prediction_dates` functions to return both prediction values and dates.
+
+- **Parameters**: 
+  - `json_file`: The JSON data input. See python tests and test files for example inputs.
+- **Returns**: A tuple containing a list of prediction values and a list of prediction dates.
+
+-------------------------
+
+### Get Glucose Effect Velocity 
+
+`get_glucose_effect_velocity(json_file, len=72)`
+
+Fetches the glucose effect velocity, which is equivalent to Insulin Counteraction Effect (ICE). 
+
+- **Parameters**: 
+  - `json_file`: The JSON data input. See python tests and test files for example inputs.
+  - `len` (optional): The number of values to fetch. Defaults to 72.
+- **Returns**: A list of glucose effect velocity values.
+
+-------------------------
+
+### Get Glucose Effect Velocity Dates
+
+`get_glucose_effect_velocity_dates(json_file)`
+
+Fetches the dates associated with the glucose effect velocity.
+
+- **Parameters**: 
+  - `json_file`: The JSON data input. See python tests and test files for example inputs.
+- **Returns**: A list of dates as strings.
+
+
+-------------------------
+
+### Get Glucose Velocity Values and Dates
+
+`get_glucose_velocity_values_and_dates(json_file)`
+
+Combines the `get_glucose_effect_velocity` and `get_glucose_effect_velocity_dates` functions to return both glucose effect velocity values and dates.
+
+- **Parameters**: 
+  - `json_file`: The JSON data input. See python tests and test files for example inputs.
+- **Returns**: A tuple containing a list of glucose effect velocity values and a list of dates.
+
+-------------------------
+
+### Get Active Carbs
+
+`get_active_carbs(json_file)`
+
+Fetches the active carbohydrates based on the provided JSON input.
+
+- **Parameters**: 
+  - `json_file`: The JSON data input. See python tests and test files for example inputs.
+- **Returns**: The active carbohydrates as a double.
+
+
+-------------------------
+
+### Get Active Insulin
+
+`get_active_insulin(json_file)`
+
+Fetches the active insulin based on the provided JSON input.
+
+- **Parameters**: 
+  - `json_file`: The JSON data input. See python tests and test files for example inputs.
+- **Returns**: The active insulin as a double.
+
+-------------------------
+
+### Percent Absorption at Percent Time
+
+`percent_absorption_at_percent_time(percent_time)`
+
+Calculates the percentage of carbohydrate absorption at a given percent time using a piecewise linear model.
+
+- **Parameters**: 
+  - `percent_time`: The time as a fraction (e.g., 0.2 for 20%).
+- **Returns**: The percentage of absorption as a double.
+
+-------------------------
+
+### Piecewise Linear Percent Rate at Percent Time
+
+`piecewise_linear_percent_rate_at_percent_time(percent_time)`
+
+Calculates the percentage rate of carbohydrate absorption at a given percent time using a piecewise linear model.
+
+- **Parameters**: 
+  - `percent_time`: The time as a fraction (e.g., 0.2 for 20%).
+- **Returns**: The percentage rate of absorption as a double.
+
+-------------------------
+
+### Linear Percent Rate at Percent Time
+
+`linear_percent_rate_at_percent_time(percent_time)`
+
+Calculates the percentage rate of carbohydrate absorption at a given percent time using a linear model.
+
+- **Parameters**: 
+  - `percent_time`: The time as a fraction (e.g., 0.2 for 20%).
+- **Returns**: The percentage rate of absorption as a double.
+
+-------------------------
+
+### Get Dynamic Carbs on Board
+
+`get_dynamic_carbs_on_board(json_file)`
+Fetches the dynamic carbohydrates on board based on the provided JSON input.
+
+- **Parameters**: 
+  - `json_file`: The JSON data input. See python tests and test files for example inputs.
+- **Returns**: The dynamic carbohydrates on board as a double.
+
+-------------------------
+
+
 
 
 ## Build Dynamic Library
@@ -150,7 +296,9 @@ After making changes in the Swift code, rebuild the dynamic library by running `
 
 
 
+## Run Tests
 
+Run command `pytest`.