UI update

.gitignore

@@ -0,0 +1,2 @@
+# Created by pytest automatically.
+*

README.md

@@ -3,27 +3,18 @@ Clinguin UI for Study regulations
 
 ### Usage
 
-#### cogsys.lp:
+#### Code from ASPOCP_23:
 ```
-clinguin client-server --domain-files new/instance/cogsys.lp new/encoding.lp --ui-files new/ui.lp -c n=4
-```
-#### cscbsc.lp:
-```
-clinguin client-server --domain-files new/instance/cscbsc.lp new/encoding.lp --ui-files new/ui.lp -c n=4
-```
-#### cscmsc.lp:
-```
-clinguin client-server --domain-files new/instance/cscmsc.lp new/encoding.lp --ui-files new/ui.lp -c n=4
-```
-#### dsmsc.lp:
-```
-clinguin client-server --domain-files new/instance/dsmsc.lp new/encoding.lp --ui-files new/ui.lp -c n=4
-```
-#### irsba.lp:
-```
-clinguin client-server --domain-files new/instance/irsba.lp new/encoding.lp --ui-files new/ui.lp -c n=4
+clinguin client-server --domain-files instances/instance_ASPOCP_23.lp encodings/encoding_ASPOCP_23.lp --ui-files encodings/ui.lp --custom-classes custom_backend.py --backend CustomBackend -c n=3
 ```
 
 
+## Custom Backend
+
+### custom_download(file_name)
+
+This function is specific to study regulation formatting. It allows users to download a study plan file with a specified name.
+
+
 ### Clinguin version
-`Clinguin 1.0.16`
+`Clinguin 1.0.32`

TODOS.md

@@ -0,0 +1,7 @@
+# ToDo List
+- [ ] create a `set_constant()` in a `custom_backend` that would allow user to update the constant dynamically from the ui (for example to set the number of semesters)
+  - [x] all tests passed for the custom_backend
+  - [x] does set_constant work in the ui?
+  - [ ] ensure that the input is only integer
+
+# Ideas

custom_backend.py

@@ -0,0 +1,104 @@
+from collections import defaultdict
+import re
+from clinguin.server.application.backends import ClingoBackend
+from clingo import Control
+from typing import Tuple, Any
+
+
+class CustomBackend(ClingoBackend):
+    def __init__(self, args: Any):
+        # Parse and store constants
+        self.current_constants = {
+            name: value
+            for const in (args.const or [])
+            for name, value in [const.split("=")]
+        }
+        super().__init__(args)
+        # Add a method to generate constant facts for the domain state
+        self._add_domain_state_constructor("_ds_generate_constant_facts")
+
+	# ---------------------------------------------
+    # Setup
+    # ---------------------------------------------
+
+
+    def _init_ctl(self):
+        """Initialize the Clingo control object with current constants and domain files."""
+        try:
+            # Create constant definitions and initialize Control
+            const_defs = [
+                f"-c {name}={value}" for name, value in self.current_constants.items()
+            ]
+            self._ctl = Control(["0"] + const_defs)
+
+            # Load domain files and add atoms
+            for f in self._domain_files:
+                self._ctl.load(str(f))
+            for atom in self._atoms:
+                self._ctl.add("base", [], str(atom) + ".")
+
+            # Ground the program
+            self._ctl.ground([("base", [])])
+        except Exception as e:
+            self._logger.error(f"Error initializing clingo.Control: {e}")
+            raise
+
+	# ---------------------------------------------
+    # Public methods
+    # ---------------------------------------------
+
+    def custom_download(self, file_name="study_plan.lp"):
+        """
+        Custom download function to save the solution in a more user-friendly format,
+        showing only assignments related to semesters and formatting them.
+        """
+        if self._model is None:
+            raise RuntimeError("Can't download when there is no model")
+
+        # Filter the model to include only semester assignments
+        semester_assignments = [
+            f"{str(atom)}."
+            for atom in self._model
+            if re.match(r"in\(\w+,s\(\d+\)\)", str(atom))
+        ]
+
+        # Format the StudyPlan
+        semesters = defaultdict(list)
+        for line in semester_assignments:
+            match = re.match(r"in\((\w+),s\((\d+)\)\)\.", line.strip())
+            if match:
+                module, semester = match.groups()
+                semesters[int(semester)].append(module)
+
+        formatted_output = ""
+        for semester in sorted(semesters.keys()):
+            formatted_output += f"Semester {semester}:\n"
+            for module in semesters[semester]:
+                formatted_output += f"{module}\n"
+            formatted_output += "\n"
+
+        # Write the formatted output to the file
+        file_name = file_name.strip('"')
+        with open(file_name, "w", encoding="UTF-8") as file:
+            file.write(formatted_output)
+
+        self._messages.append(
+            (
+                "Download successful",
+                f"Information saved in file {file_name}.",
+                "success",
+            )
+        )
+
+	# ---------------------------------------------
+    # Properties
+    # ---------------------------------------------
+
+    @property
+    def _ds_generate_constant_facts(self) -> str:
+        """Generate facts for current constants."""
+        facts = [
+            f"_clinguin_const({name},{value})."
+            for name, value in self.current_constants.items()
+        ]
+        return "#defined _clinguin_const/2." + " ".join(facts) + "\n"