Adds config files for the API

.gitignore

@@ -165,4 +165,6 @@ cython_debug/
 .vscode/
 
 # Mac Os
-.DS_Store
+.DS_Store
+
+config.toml

configs/config_app_example.toml

@@ -0,0 +1,40 @@
+# MAKE SURE TO RENAME THIS FILE TO config.toml AND PLACE IT IN THE ROOT OF THE PROJECT
+
+# Router configuration
+router_name = "router1"
+router_address = "xx.xx.xx.xx"  # Replace with actual IP address
+router_port = 5555
+
+# Timetagger configuration (provider_name, instrument_name)
+timetagger = ["provider", "tagger"] # Replace with actual provider and instrument names
+
+# Bell state configuration (default: Phi_plus)
+bell_state = 0
+
+# CHSH experiment settings
+[chsh_settings]
+hwp = ["provider", "instrument_hwp"]  # Replace with actual HWP names
+request_hwp = ["provider", "instrument_hwp"]
+
+# CHSH measurement configuration
+[chsh_settings.measurement_config]
+integration_time_s= 5
+binwidth = 500
+channel1 = 1
+channel2 = 2
+dark_count = 0
+
+# QKD experiment settings
+[qkd_settings]
+hwp = ["provider", "instrument_hwp"]
+request_hwp = ["provider", "instrument_hwp"]
+bitstring_length = 4
+discriminating_threshold = 10
+
+# QKD measurement configuration
+[qkd_settings.measurement_config]
+integration_time_s = 5
+binwidth = 500
+channel1 = 1
+channel2 = 2
+dark_count = 0

configs/config_messaging_example.toml

@@ -0,0 +1,23 @@
+[router]
+name = "pqnstack-router"
+host = "localhost"
+port = 5556
+
+[provider]
+name = "pqnstack-provider"
+router_name = "pqnstack-router"
+host = "localhost"
+port = 5556
+beat_period = 2000
+
+[[provider.instruments]]
+name = "dummy1"
+import = "pqnstack.pqn.drivers.dummies.DummyInstrument"
+desc = "Dummy instrument1 for testing purposes"
+hw_address = "1234"
+
+[[provider.instruments]]
+name = "dummy2"
+import = "pqnstack.pqn.drivers.dummies.DummyInstrument"
+desc = "Dummy instrument2 for testing purposes"
+hw_address = "1234"

pyproject.toml

@@ -30,7 +30,7 @@ pqn = "pqnstack.cli:app"
 webapp = [
     "fastapi[standard]>=0.115.14",
     "httpx>=0.28.1",
-    "pydantic>=2.11.7",
+    "pydantic-settings>=2.10.1",
 ]
 
 [dependency-groups]

src/pqnstack/app/core/config.py

@@ -1,8 +1,12 @@
 import logging
-from dataclasses import dataclass
-from dataclasses import field
+from functools import lru_cache
 
 from pydantic import BaseModel
+from pydantic import Field
+from pydantic_settings import BaseSettings
+from pydantic_settings import PydanticBaseSettingsSource
+from pydantic_settings import SettingsConfigDict
+from pydantic_settings import TomlConfigSettingsSource
 
 from pqnstack.constants import BellState
 from pqnstack.constants import QKDEncodingBasis
@@ -11,39 +15,53 @@
 logger = logging.getLogger(__name__)
 
 
-@dataclass
-class CHSHSettings:
+class CHSHSettings(BaseModel):
     # Specifies which half waveplate to use for the CHSH experiment. First value is the provider's name, second is the motor name.
     hwp: tuple[str, str] = ("", "")
     request_hwp: tuple[str, str] = ("", "")
-    measurement_config: MeasurementConfig = field(default_factory=lambda: MeasurementConfig(5))
+    measurement_config: MeasurementConfig = Field(default_factory=lambda: MeasurementConfig(integration_time_s=5))
 
 
-@dataclass
-class QKDSettings:
+class QKDSettings(BaseModel):
     hwp: tuple[str, str] = ("", "")
     request_hwp: tuple[str, str] = ("", "")
     bitstring_length: int = 4
-    discriminating_threshold = 10
-    measurement_config: MeasurementConfig = field(default_factory=lambda: MeasurementConfig(5))
+    discriminating_threshold: int = 10
+    measurement_config: MeasurementConfig = Field(default_factory=lambda: MeasurementConfig(integration_time_s=5))
 
 
-@dataclass
-class Settings:
-    router_name: str
-    router_address: str
-    router_port: int
-    chsh_settings: CHSHSettings
-    qkd_settings: QKDSettings
+class Settings(BaseSettings):
+    router_name: str = "router1"
+    router_address: str = "localhost"
+    router_port: int = 5555
+    chsh_settings: CHSHSettings = CHSHSettings()
+    qkd_settings: QKDSettings = QKDSettings()
     bell_state: BellState = BellState.Phi_plus
     timetagger: tuple[str, str] | None = None  # Name of the timetagger to use for the CHSH experiment.
 
-
-static_typecheck_msg = "Please set the global 'settings' variable before use."
-
-
+    model_config = SettingsConfigDict(toml_file="./config.toml", env_file=".env", env_file_encoding="utf-8")
+
+    @classmethod
+    def settings_customise_sources(
+        cls,
+        settings_cls: type[BaseSettings],
+        init_settings: PydanticBaseSettingsSource,
+        env_settings: PydanticBaseSettingsSource,
+        dotenv_settings: PydanticBaseSettingsSource,
+        file_secret_settings: PydanticBaseSettingsSource,
+    ) -> tuple[PydanticBaseSettingsSource, ...]:
+        return (
+            TomlConfigSettingsSource(settings_cls),
+            env_settings,
+            dotenv_settings,
+            file_secret_settings,
+            init_settings,
+        )
+
+
+@lru_cache
 def get_settings() -> Settings:
-    raise NotImplementedError(static_typecheck_msg)
+    return Settings()
 
 
 settings = get_settings()

src/pqnstack/pqn/protocols/measurement.py

@@ -1,8 +1,9 @@
 from dataclasses import dataclass
 
+from pydantic import BaseModel
 
-@dataclass
-class MeasurementConfig:
+
+class MeasurementConfig(BaseModel):
     integration_time_s: float
     binwidth_ps: int = 500
     channel1: int = 1