fiqus 2024.7.0__py3-none-any.whl → 2024.12.1__py3-none-any.whl

fiqus/data/DataSettings.py

@@ -0,0 +1,121 @@
+from typing import Literal, Optional
+
+from pydantic import BaseModel, Field
+
+
+class Condor(BaseModel):
+    """
+    Class for running using HTCondor queuing (only on Linux)
+    """
+
+    error: Optional[str] = Field(
+        default=None,
+        title="error",
+        description="Error file name and extension, like error.txt",
+    )
+    output: Optional[str] = Field(
+        default=None,
+        title="output",
+        description="Output file name and extension, like output.txt",
+    )
+    log: Optional[str] = Field(
+        default=None,
+        title="log",
+        description="Log file name and extension, like log.txt",
+    )
+    request_cpus: Optional[int] = Field(
+        default=None,
+        title="request_cpus",
+        description="Number of CPUs to request on each machine",
+    )
+    request_memory: Optional[str] = Field(
+        default=None,
+        title="request_memory",
+        description="Amount of memory to request on each machine as a string (e.g., '16G')",
+    ) 
+    request_disk: Optional[str] = Field(
+        default=None,
+        title="request_disk",
+        description="Amount of disk space to request on each machine as a string (e.g., '16G')",
+    )
+    singularity_image_path: Optional[str] = Field(
+        default=None,
+        title="SingularityImagePath",
+        description="Full path to Singularity image",
+    )
+    cerngetdp_version: Optional[str] = Field(
+        default=None,
+        title="CERNGetDP Version",
+        description="Version of CERNGetDP to be used",
+    )
+    should_transfer_files: Literal["YES", "NO"] = Field(
+        default="YES",
+        title="should_transfer_files",
+        description="Sets if files should be transferred",
+    )
+    max_run_time: Optional[int] = Field(
+        default=None,
+        title="MaxRuntime",
+        description=(
+            "Specifies maximum run time in seconds to request for the job to go into"
+            " the queue"
+        ),
+    )
+    eos_relative_output_path: Optional[str] = Field(
+        default=None,
+        title="eos_relative_output_path",
+        description=(
+            "This is relative path in the user eos folder. This path gets appended to"
+            " the root path: root://eosuser.cern.ch//eos/user/u/username"
+        ),
+    )
+    big_mem_job: Optional[bool] = Field(
+        default=None,
+        title="BigMemJob",
+        description=(
+            "If true a machine with 1TB of RAM and 24 cores is requested. Expect longer"
+            " queuing time"
+        ),
+    )
+
+class Subproc(BaseModel):
+    """
+    Class for running using subprocess calls (on Windows)
+    """
+
+    executable: Optional[str] = Field(
+        default=None,
+        title="executable",
+        description="Executable or script to run, like run_fiqus.py",
+    )
+    full_output_path: Optional[str] = Field(
+        default=None,
+        title="full_output_path",
+        description="A full path to the output folder",
+    )
+
+
+class DataSettings(BaseModel):
+    """
+    Configuration for HTCondor and
+    """
+
+    GetDP_path: Optional[str] = Field(
+        default=None,
+        title="GetDP_path",
+        description=(
+            "Full path to GetDP executable. This is only needed and used on Windows"
+        ),
+    )
+
+    base_path_model_files: Optional[str] = Field(
+        default=None,
+        title="base_path_model_files",
+        description=(
+            "Path to the base model folder where model files are stored that are needed to run FiQuS."
+            "This is only needed when the files are not in the same folder as the input yaml (e.g., on HTCondor)"
+        )
+    )
+
+    htcondor: Condor = Condor()
+    subproc: Subproc = Subproc()

fiqus/data/DataWindingsCCT.py

@@ -1,37 +1,37 @@
-from pydantic import BaseModel
-from typing import List, Optional
-
-
-class Terminal(BaseModel):
-    vol_st: Optional[List[int]] = None  # volume number for terminal in for straightening
-    surf_st: Optional[List[int]] = None  # surface number for terminal in for straightening
-    vol_et: Optional[List[int]] = None  # volume number for terminal in for extending
-    surf_et: Optional[List[int]] = None  # surface number for terminal in for extending
-    lc_st: Optional[List[List[List[int]]]] = None  # line connections for straightening terminals
-    lc_et: Optional[List[List[List[int]]]] = None  # line connections for extending terminals
-    z_air: Optional[float] = None
-    z_add: Optional[float] = None
-    ndpterms: Optional[List[int]] = None  # number of divisions per terminal
-
-
-class Winding(BaseModel):
-    names: Optional[List[str]] = None  # name to use in gmsh and getdp
-    t_in: Terminal = Terminal()     # Terminal in
-    t_out: Terminal = Terminal()    # Terminal in
-
-
-class WindingsInformation(BaseModel):
-    magnet_name: Optional[str] = None
-    windings_avg_length: Optional[float] = None
-    windings: Winding = Winding()
-    w_names: Optional[List[str]] = None
-    f_names: Optional[List[str]] = None
-    formers: Optional[List[str]] = None
-    air: Optional[str] = None
-
-
-class SpliterBrep(BaseModel):  # Brep file model splitter data
-    magnet_name: Optional[str] = None
-    file_name: Optional[str] = None           # full file name for the brep file
-    vol_firsts: Optional[List[int]] = None    # list of first volumes for the partitioned model
-    vol_lasts: Optional[List[int]] = None      # list of last volumes for the partitioned model
+from pydantic import BaseModel
+from typing import List, Optional
+
+
+class Terminal(BaseModel):
+    vol_st: Optional[List[int]] = None  # volume number for terminal in for straightening
+    surf_st: Optional[List[int]] = None  # surface number for terminal in for straightening
+    vol_et: Optional[List[int]] = None  # volume number for terminal in for extending
+    surf_et: Optional[List[int]] = None  # surface number for terminal in for extending
+    lc_st: Optional[List[List[List[int]]]] = None  # line connections for straightening terminals
+    lc_et: Optional[List[List[List[int]]]] = None  # line connections for extending terminals
+    z_air: Optional[float] = None
+    z_add: Optional[float] = None
+    ndpterms: Optional[List[int]] = None  # number of divisions per terminal
+
+
+class Winding(BaseModel):
+    names: Optional[List[str]] = None  # name to use in gmsh and getdp
+    t_in: Terminal = Terminal()     # Terminal in
+    t_out: Terminal = Terminal()    # Terminal in
+
+
+class WindingsInformation(BaseModel):
+    magnet_name: Optional[str] = None
+    windings_avg_length: Optional[float] = None
+    windings: Winding = Winding()
+    w_names: Optional[List[str]] = None
+    f_names: Optional[List[str]] = None
+    formers: Optional[List[str]] = None
+    air: Optional[str] = None
+
+
+class SpliterBrep(BaseModel):  # Brep file model splitter data
+    magnet_name: Optional[str] = None
+    file_name: Optional[str] = None           # full file name for the brep file
+    vol_firsts: Optional[List[int]] = None    # list of first volumes for the partitioned model
+    vol_lasts: Optional[List[int]] = None      # list of last volumes for the partitioned model

fiqus/data/RegionsModelFiQuS.py

@@ -1,5 +1,5 @@
 from pydantic import BaseModel
-from typing import (List, Dict, Optional)
+from typing import List, Dict, Union, Optional
 
 
 class Region(BaseModel):
@@ -15,7 +15,7 @@ class Regions(BaseModel):
 class TwoParBoundaryRegions(BaseModel):
     names: Optional[List[List[str]]] = None
     numbers: Optional[List[List[int]]] = None
-    values: Optional[List[List[float]]] = None
+    values: Optional[List[List[Union[float, str]]]] = None
 
 
 class OneParBoundaryRegions(BaseModel):
@@ -96,6 +96,7 @@ class Powered(BaseModel):
 
 class Induced(BaseModel):
     vol: InducedRegions = InducedRegions()  # volume region
+    surf_th: Regions = Regions()  # surface region
     surf_in: Regions = Regions()  # input terminal surface region
     surf_out: Regions = Regions()  # output terminal surface region
     cochain: Regions = Regions()  # winding cochain (cut)
@@ -115,8 +116,8 @@ class Iron(BaseModel):
 class Air(BaseModel):
     vol: AirRegion = AirRegion()  # volume region
     surf: Region = Region()  # surface region
-    line: Region = Region()    # line region
-    point: Regions = Regions()    # point region
+    line: Region = Region()  # line region
+    point: Regions = Regions()  # point region
     cochain: Regions = Regions()  # air cochain (cut)
 
 
@@ -171,6 +172,9 @@ class InsulationType(BaseModel):
     thin_shells: List[List[int]] = []
     layers_material: List[List[str]] = []
     thicknesses: List[List[float]] = []
+    label: List[List[Union[int, None]]] = (
+        []
+    )  # useful to indicate which quench heater a SS element refers to
 
 
 class ThinShell(BaseModel):
@@ -182,9 +186,14 @@ class ThinShell(BaseModel):
     quench_heaters: InsulationType = InsulationType()
 
 
+class PostProc(BaseModel):
+    vol: Regions = Regions()  # postprocessing volumes general
+    surf: Regions = Regions()  # postprocessing volumes general
+    line: Regions = Regions()  # postprocessing volumes general
+    point: Regions = Regions()  # postprocessing volumes general
+
+
 class RegionsModel(BaseModel):
-    # powered: Powered = Powered()
-    # induced: Induced = Induced()
     powered: Dict[str, Powered] = {}
     induced: Dict[str, Induced] = {}
     insulator: Insulator = Insulator()
@@ -192,7 +201,10 @@ class RegionsModel(BaseModel):
     air: Air = Air()
     air_far_field: AirFarField = AirFarField()
     thin_shells: ThinShell = ThinShell()
+    projection_points: Region = Region()
     boundaries: BoundaryConditions = BoundaryConditions()
+    postproc_th: PostProc = PostProc()
+    postproc_em: PostProc = PostProc()
 
 
 # if __name__ == "__main__":