added newlines

Author: alexhroom

RATapi/controls.py

@@ -45,65 +45,93 @@ class Controls(BaseModel, validate_assignment=True, extra="forbid"):
     # All Procedures
     procedure: Procedures = Procedures.Calculate
     """Which procedure RAT should execute. Can be 'calculate', 'simplex', 'de', 'ns', or 'dream'."""
+
     parallel: Parallel = Parallel.Single
     """How the calculation should be parallelised. Can be 'single', 'contrasts' or 'points'."""
+
     calcSldDuringFit: bool = False
     """Whether SLD will be calculated during fit (for live plotting etc.)"""
+
     resampleMinAngle: float = Field(0.9, le=1, gt=0)
     """The upper threshold on the angle between three sampled points for resampling, in radians over pi."""
+
     resampleNPoints: int = Field(50, gt=0)
     """The number of initial points to use for resampling."""
+
     display: Display = Display.Iter
     """How much RAT should print to the terminal. Can be 'off', 'iter', 'notify', or 'final'."""
+
     # Simplex
     xTolerance: float = Field(1.0e-6, gt=0.0)
     """[SIMPLEX] The termination tolerance for step size."""
+
     funcTolerance: float = Field(1.0e-6, gt=0.0)
     """[SIMPLEX] The termination tolerance for change in chi-squared."""
+
     maxFuncEvals: int = Field(10000, gt=0)
     """[SIMPLEX] The maximum number of function evaluations before the algorithm terminates."""
+
     maxIterations: int = Field(1000, gt=0)
     """[SIMPLEX] The maximum number of iterations before the algorithm terminates."""
+
     # Simplex and DE
     updateFreq: int = 1
     """[SIMPLEX, DE] How often to print out progress to the terminal, in iterations."""
+
     updatePlotFreq: int = 20
     """[SIMPLEX, DE] How often the live plot should be updated if using."""
+
     # DE
     populationSize: int = Field(20, ge=1)
     """[DE] The number of candidate solutions that exist at any time."""
+
     fWeight: float = 0.5
     """[DE] The step size for how different mutations are to their parents."""
+
     crossoverProbability: float = Field(0.8, gt=0.0, lt=1.0)
     """[DE] The probability of exchange of parameters between individuals at any iteration."""
+
     strategy: Strategies = Strategies.RandomWithPerVectorDither
     """[DE] The algorithm used to generate new candidates."""
+
     targetValue: float = Field(1.0, ge=1.0)
     """[DE] The value of chi-squared at which the algorithm will terminate."""
+
     numGenerations: int = Field(500, ge=1)
     """[DE] The maximum number of iterations before the algorithm terminates."""
+
     # NS
     nLive: int = Field(150, ge=1)
     """[NS] The number of points to sample."""
+
     nMCMC: int = Field(0, ge=0)
     """[NS] If non-zero, an MCMC process with ``nMCMC`` chains will be used instead of MultiNest."""
+
     propScale: float = Field(0.1, gt=0.0, lt=1.0)
     """[NS] A scaling factor for the ellipsoid generated by MultiNest."""
+
     nsTolerance: float = Field(0.1, ge=0.0)
     """[NS] The tolerance threshold for when the algorithm should terminate."""
+
     # Dream
     nSamples: int = Field(20000, ge=0)
     """[DREAM] The number of samples in the initial population for each chain."""
+
     nChains: int = Field(10, gt=0)
     """[DREAM] The number of Markov chains to use in the algorithm."""
+
     jumpProbability: float = Field(0.5, gt=0.0, lt=1.0)
     """[DREAM] The probability range for the size of jumps in sampling. Larger values mean more variable jumps."""
+
     pUnitGamma: float = Field(0.2, gt=0.0, lt=1.0)
     """[DREAM] The probability that the scaling-down factor of jumps will be ignored and a larger jump will be taken."""
+
     boundHandling: BoundHandling = BoundHandling.Reflect
     """[DREAM] How steps past the space boundaries should be handled. Can be 'off', 'reflect', 'bound', or 'fold'."""
+
     adaptPCR: bool = True
     """[DREAM] Whether the crossover probability for differential evolution should be adapted during the run."""
+
     # Private field for IPC file
     _IPCFilePath: str = ""
 

RATapi/project.py

@@ -135,12 +135,16 @@ class Project(BaseModel, validate_assignment=True, extra="forbid"):
 
     name: str = ""
     """The name of the project."""
+
     calculation: Calculations = Calculations.Normal
     """What calculation type should be used. Can be 'normal' or 'domains'."""
+
     model: LayerModels = LayerModels.StandardLayers
     """What layer model should be used. Can be 'standard layers', 'custom layers', or 'custom xy'."""
+
     geometry: Geometries = Geometries.AirSubstrate
     """What geometry should be used. Can be 'air/substrate' or 'substrate/liquid'"""
+
     absorption: bool = False
     """Whether imaginary (absorption) SLD should be accounted for."""
 
@@ -243,8 +247,10 @@ class Project(BaseModel, validate_assignment=True, extra="forbid"):
 
     custom_files: ClassList[RATapi.models.CustomFile] = ClassList()
     """Handles for custom files used by the project."""
+
     data: ClassList[RATapi.models.Data] = ClassList()
     """Arrays of experimental data corresponding to a model."""
+
     layers: Union[
         Annotated[ClassList[RATapi.models.Layer], Tag("no_abs")],
         Annotated[ClassList[RATapi.models.AbsorptionLayer], Tag("abs")],
@@ -258,8 +264,10 @@ class Project(BaseModel, validate_assignment=True, extra="forbid"):
         ),
     )
     """The layers of a standard layer model."""
+
     domain_contrasts: ClassList[RATapi.models.DomainContrast] = ClassList()
     """The groups of layers required by each domain in a domains model."""
+
     contrasts: Union[
         Annotated[ClassList[RATapi.models.Contrast], Tag("no_ratio")],
         Annotated[ClassList[RATapi.models.ContrastWithRatio], Tag("ratio")],