Fixed academic group histories, tasks calculating student loads, added script to fix mis-imported loads.

Author: smangham

Makefile

@@ -105,7 +105,7 @@ print-%:
 # PROJECT COMMANDS
 ############################################################################################
 
-data: site school unit task
+data: site school unit task assignment
 
 site:
 	uv run physics_workload/manage.py loaddata site info
@@ -139,6 +139,8 @@ superuser:
 
 initialise:
 	uv run physics_workload/manage.py initialise
+	uv run physics_workload/manage.py calchistoric
+	uv run physics_workload/manage.py fixtaskfirsttime
 
 all: database data initialise
 

README.md

@@ -21,10 +21,11 @@ It's not included in the repo as it contains personally identifiable data.
 
 ### File Server
 
-If using this on a machine serving multiple sites, 
-you'll need to add the configuration file to your existing Nginx setup. 
+If using this on a machine serving multiple sites,
+you'll need to add the configuration file to your existing Nginx setup.
 Assign ownership of the directory to the `physics-workload-staff` group and add `nginx` to it:
-```bash 
+
+```bash
 $ sudo usermod -a -G physics-workload-staff nginx
 $ sudo chgrp -R voidorchestra-staff /var/www/physics-workload
 $ sudo chmod -R g+rw /var/www/physics-workload 
@@ -33,26 +34,29 @@ $ sudo chmod -R g+rw /var/www/physics-workload
 Then, depending on your Linux distribution:
 
 #### Debian/Ubuntu
+
 Copy or link `nginx/physics-workload.conf` to your `/etc/nginx/sites-enabled/` directory, then restart Nginx:
+
 ```bash
 $ ln -s /var/www/physics-workload/nginx/physics-workload.conf /etc/nginx/sites-enabled/ 
 $ sudo systemctl reload nginx
 $ sudo systemctl restart nginx
 ```
 
 #### Fedora/RHEL
+
 Copy `nginx/physics-workload.conf` file to your `/etc/nginx/conf.d` directory.
 Then, flag the log directory as a log directory under SELinux,
 and the output directory as as HTML content directory too:
-```bash 
+
+```bash
 $ sudo cp /var/www/voidorchestra/nginx/physics-workload.conf /etc/nginx/conf.d/ 
 $ sudo semanage fcontext -a -t httpd_sys_content_t "/var/www/physics-workload/staticfiles(/.*)?"
 $ sudo restorecon -R -v /var/www/physics-workload/staticfiles
 $ sudo semanage fcontext -a -t httpd_log_t "/var/www/physics-workload/logs(/.*)?"
 $ sudo restorecon -R -v /var/www/physics-workload/logs/
 ```
 
-
 ## Running
 
 The tool is run using `docker compose`. Generally, it's best to do this in a `screen` session.
@@ -65,26 +69,26 @@ sudo docker compose up web
 
 ### Initialising
 
-If this is the first time the tool is being run, import the `.csv` data:
+If this is the first time the tool is being run, import the `.xlsx` data:
 
 ```bash
 sudo docker exec -it physics-workload-django /bin/bash 
-make clean
-make data
+make all
 ```
 
 Then, log into the website to link your user account to the site.
 The command `python physics_workload/manage.py makestaff <account>` will then make the user associated with the 365 account `<account>` site staff;
-e.g. 
+e.g.
+
 ```bash
 python physics_workload/manage.py makestaff swm1r18
 ```
 
 ### Manual Tweaks
 
 The output of `make data` should list the Tasks, Staff and Units that weren't able to be automatically imported.
-You should then get a file `failed_assignments.csv` out; 
-this is the lines from the "Staff Tasks" sheet of the Excel file that failed to import. 
+You should then get a file `failed_assignments.csv` out;
+this is the lines from the "Staff Tasks" sheet of the Excel file that failed to import.
 
 ## Updating
 
@@ -97,8 +101,6 @@ sudo docker compose build --no-cache
 sudo docker compose up web
 ```
 
-
-
 # Extra
 
 > [!NOTE]

physics_workload/app/forms/task.py

@@ -47,10 +47,11 @@ class Meta:
         title = "Details"
         fields = dict(
             academic_group__include=lambda task, **_: task.academic_group,
-            load_calc__group="Calculated Load",
+            load_calc=dict(group="Calculated Load", include=lambda task, **_: task.assignment_students != Task.AssignmentStudentsChoices.REQUIRED),
             load_calc_first=dict(
                 group="Calculated Load",
-                include=lambda task, **_: task.load_calc_first != task.load_calc,
+                include=lambda task, **_: task.load_calc_first != task.load_calc
+                and task.assignment_students != Task.AssignmentStudentsChoices.REQUIRED,
             ),
             is_required=dict(
                 group="Calculated Load",
@@ -84,17 +85,18 @@ class Meta:
             ),
             load_function=dict(
                 include=lambda task, **_: task.load_function,
+                non_editable_input__template="app/choice_url.html",
                 group="Calculation Details",
                 after="exam_fraction",
             ),
             students=dict(
-                include=lambda task, **_: not task.assignment_students=="INVALID",
+                include=lambda task, **_: task.assignment_students == Task.AssignmentStudentsChoices.OPTIONAL,
                 group="Calculation Details",
                 after="load_function",
             ),
             assignment_students=dict(
                 include=False,
-            )
+            ),
         )
         editable = False
 
@@ -216,9 +218,7 @@ class Meta:
                 initial="Unit Lead",
                 group="Basic",
             ),
-            assignment_students=Field.hardcoded(
-                parsed_data="INVALID"
-            ),
+            assignment_students=Field.hardcoded(parsed_data=Task.AssignmentStudentsChoices.INVALID),
             is_unique=dict(
                 group="Basic",
                 initial=True,
@@ -266,7 +266,9 @@ class Meta:
             load_fixed_first__group="Load",
             load_multiplier__group="Load",
             load_function__group="Calculation",
-            assignment_students__group="Calculation",
+            assignment_students=dict(
+                group="Calculation",
+            ),
             students__group="Calculation",
         )
 

physics_workload/app/forms/unit.py

@@ -18,9 +18,9 @@ class Meta:
         auto__exclude = ["task_set"]
         fields__code__group = "Basics"
         fields__name__group = "Basics"
-        fields__academic_group=dict(
-            group = "Basics",
-            non_editable_input__template = "app/choice_url.html",
+        fields__academic_group = dict(
+            group="Basics",
+            non_editable_input__template="app/choice_url.html",
             include=lambda unit, **_: unit.academic_group,
         )
         fields__students__group = "Basics"

physics_workload/app/main_menu/__init__.py

@@ -1,9 +1,7 @@
-from django.urls import reverse_lazy
+from django.urls import reverse, reverse_lazy
 from django.views.generic import RedirectView
 from iommi.main_menu import M, MainMenu
 
-from django.urls import reverse_lazy, reverse
-
 from app.main_menu.academic_group import academic_group_submenu
 from app.main_menu.info import info_submenu
 from app.main_menu.load_function import load_function_submenu
@@ -14,7 +12,6 @@
 from app.pages.basic import AboutPage, PrivacyPage
 from app.views import home_redirect
 
-
 main_menu = MainMenu(
     items=dict(
         index=M(
@@ -31,10 +28,7 @@
             render=False,
             view=PrivacyPage().as_view(),
         ),
-        about=M(
-            render=False,
-            view=AboutPage().as_view()
-        ),
+        about=M(render=False, view=AboutPage().as_view()),
         staff=staff_submenu,
         module=unit_submenu,
         task=task_submenu,

physics_workload/app/main_menu/academic_group.py

@@ -2,7 +2,6 @@
 from iommi.main_menu import M
 from iommi.path import register_path_decoding
 
-
 from app.models import AcademicGroup, Task
 from app.pages.academic_group import (
     AcademicGroupCreate,
@@ -15,7 +14,6 @@
 from app.pages.academic_group.history import AcademicGroupHistoryList
 from app.pages.task import TaskDelete, TaskDetail, TaskEdit
 
-
 # Decodes "<academic_group>" in paths to add academic_group to params
 register_path_decoding(academic_group=AcademicGroup)
 

physics_workload/app/management/commands/calchistoric.py

@@ -7,6 +7,7 @@
 from django.conf import settings
 from django.core.management.base import BaseCommand
 from django.db.models import Sum
+
 from app.models import AcademicGroup, Staff
 
 logger: Logger = getLogger(__name__)
@@ -29,7 +30,7 @@ def handle(self, *args: Path, **options):
         date_2022: datetime = datetime(year=2022, month=9, day=20, hour=0, minute=0, second=0, tzinfo=ZoneInfo("GMT"))
         date_2023: datetime = datetime(year=2023, month=9, day=20, hour=0, minute=0, second=0, tzinfo=ZoneInfo("GMT"))
         date_2024: datetime = datetime(year=2024, month=9, day=20, hour=0, minute=0, second=0, tzinfo=ZoneInfo("GMT"))
-        date_2025: datetime = datetime(year=2025, month=9, day=20, hour=0, minute=0, second=0, tzinfo=ZoneInfo("GMT"))
+        # date_2025: datetime = datetime(year=2025, month=9, day=20, hour=0, minute=0, second=0, tzinfo=ZoneInfo("GMT"))
 
         for academic_group in AcademicGroup.objects.all():
             for history in academic_group.history.all():
@@ -69,6 +70,4 @@ def handle(self, *args: Path, **options):
         # Stop tracking history changes.
         settings.SIMPLE_HISTORY_ENABLED = False
 
-        self.stdout.write(
-            self.style.SUCCESS("Calculation finished.")
-        )
+        self.stdout.write(self.style.SUCCESS("Calculation finished."))

physics_workload/app/management/commands/calcloads.py

@@ -0,0 +1,25 @@
+from django.core.management.base import BaseCommand
+
+from app.models import Task
+
+
+class Command(BaseCommand):
+    """
+    Initialises the staff workloads in the database.
+    """
+
+    help = "Fixes imported tasks where the 'first time' value is not a bonus added, but the flat value."
+
+    def handle(self, *args, **options):
+        fixed_loads: int = 0
+
+        for task in Task.objects.all():
+            if task.load_fixed_first and task.load_fixed_first > task.load_fixed:
+                task.load_fixed_first = task.load_fixed_first - task.load_fixed
+                task.save()
+                fixed_loads += 1
+
+            if task.is_lead or task.is_full_time or task.is_unique:
+                task.assignment_students = Task.AssignmentStudentsChoices.INVALID
+
+        self.stdout.write(self.style.SUCCESS(f"Successfully fixed {fixed_loads} tasks."))