Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Added details indicating that test_step_time.py also includes tests for target_zone_estimation.
  • Loading branch information
Nissa9902 authored Oct 29, 2024
1 parent ea48f0b commit 03b5cf7
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions backend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# Step-Time Biofeedback Backend

## Description
This README provides instructions on how to install necessary dependencies, and run the tests for `Step_Time_Calculation.py`
This README provides instructions on how to install necessary dependencies, and run the tests for `Step_Time_Calculation.py` and `target_zone_estimationn.py`.

## Prerequisites
Before running any code, make sure you're in your Python virtual environment. Once activated, you can install the required dependencies by running:
Expand Down Expand Up @@ -81,7 +81,7 @@ brew install numpy
## Running Unit Tests

### How to run the test
Unit tests are provided to ensure the correctness of the step time calculations. Follow the steps below to run the tests successfully:
The unit tests verify the accuracy of the step time calculations and target zone estimations. Follow the steps below to run the tests successfully:

1) Navigate to the backend directory.
2) Run the test file using Python's unittest module:
Expand All @@ -94,6 +94,8 @@ The tests from `test_step_time` cover:
- Step time calculation for values below the threshold (20N).
- Step time output as a moving average of 2 steps.
- Step time output as a continuous number in the format 00.00.
- Target zone estimation based on calculated step times.
- Real data validation using sample data provided in tied belt OSS_f_1.tsv.

### Sample Data for Testing
The function uses sample force data in the format (time, force) to calculate step times.
Sample data should be in the format (time, force), where time is the time point, and force represents the force measurement. The calculate_step_time function calculates step times from this data.

0 comments on commit 03b5cf7

Please sign in to comment.