Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
carmen904c authored Nov 24, 2024
1 parent 2647a77 commit e94f0fb
Showing 1 changed file with 2 additions and 47 deletions.
49 changes: 2 additions & 47 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
# New_VSVS_Scheduler

**Final version used Fall 2020 with results**

![Python application](https://github.com/VanderbiltSVS/New_VSVS_Scheduler/workflows/Python%20application/badge.svg?branch=Fall_2020)

Project started October 2019

**Authors**: 2020 VSVS IT Committee (David Ward, Michael Selzer, Katie Helman, Nilai Vemula, Rishi Das)
**Authors**:[`docs/authors.txt`](Authors)

**Description**: Imports data from data/classrooms.csv, data/individuals.csv, and data/partners.csv and assigns
volunteers to groups. Assigns partners, then drivers, then team leaders, then everyone else. Outputs results in results/assignments.csv.
Expand Down Expand Up @@ -61,50 +59,7 @@ This repository has/will have the following files:
- main.py (sorting algorithm, handle input + output files)
- volunteer.py (contains the Volunteer class)
```


## Sorting Algorithm

Description of how the sorting algo works, flowchart, etc

### Classroom Class

The classroom class has the following members:

- group_number
- teacher_name
- teacher_phone
- school
- teacher_email
- day_of_week
- volunteers_assigned
- t_leader (does this classroom have a team leader?)
- driver (does this classroom have a driver?)
- class_start_time (time the class starts in military time)
- class_end_time (time the class ends in military time)
- free_time_start (the latest time a volunteer can start being available and be able to make this lesson)
- volunteer_time_needed (minutes of free time needed starting at free_time_start for a volunteer to be able to make
this lesson)
- start_time_schedule_index (the index in the array of Volunteer attribute free_time_array (or partner_schedule) that needs to be >= volunteer_time_needed for a volunteer to be able to visit this classroom)
- has_in_person_volunteer (does this classroom have at least one in-person volunteer?)

### Volunteer Class

The volunteer class has the following members:

- applied_t_leader (volunteer applied to be a team leader?)
- car_passengers (people a driver can drive (not including driver))
- driver (if they have a car that can carry the MAX_TEAM_SIZE)
- schedule_array (boolean array containing an index for each 15-min block between the times of 7:15am-3:45pm, Monday through Thursday)
- free_time_array (boolean array for same time slots as above, showing if volunteer is free)
- group_number (-1 if unassigned)
- partners (number of other partners)
- partner_indexes
- partner_free_time_array
- assigned_driver (Was the volunteer assigned to be the driver for their group?)
- assigned_t_leader (Was the volunteer assigned to be their group's team leader?)
- classrooms_possible = (Number of classrooms the volunteer can make according to their schedule.)
- is_in_person (True if the volunteer is in person, False if they are remote.)


## To-do

Expand Down

0 comments on commit e94f0fb

Please sign in to comment.