[RabiyaF]

Task List

• Added the enums.
  1. ParallelOptions
  2. Procedures
  3. DisplayOptions
  4. BoundHandlingOptions
  5. StrategyOptions
• Added pydantic classes for procedures.
  1. Added BaseProcedure with following properties:
     - parallel
     - calcSldDuringFit
     - resamPars
     - display
  2. Added Calculate with following properties:
     - procedure
  3. Added Simplex with following properties:
     - procedure
     - tolX
     - tolFun
     - maxFunEvals
     - maxIter
     - updateFreq
     - updatePlotFreq
  4. Added DE with following properties:
     - procedure
     - populationSize
     - fWeight
     - crossoverProbability
     - strategy
     - targetValue
     - numGenerations
  5. Added NS with following properties:
     - procedure
     - Nlive
     - Nmcmc
     - propScale
     - nsTolerance
  6. Added Dream with following properties:
     - procedure
     - nSamples
     - nChains
     - jumpProb originally named lambda in MATLAB
     - pUnitGamma
     - boundHandling
• Refactored ControlsClass.
• Verified similar exceptions are raised in python as the MATLAB version.
• Added verification of inputs.
• Added __repr__ method.
  
• Added tests. Test Coverage:
• Added doc strings.

What kind of change does this PR introduce ?

• Feature / New class in python / Rewrite of MATLAB class

What is the current behaviour ?

• python version of RAT lacked the controlClass. Closes Add the controlsClass #7

What is the new behaviour ?

• PR will add ControlsClass in the python version of RAT which allows users to define the calculation settings.

Does this PR introduce a breaking change ?

• lambda variable from MATLAB class is renamed in python version to jumpProb.
• None in boundHandlingOptions enum from MATLAB is renamed in python version to off.

Other Information

• setProcedure method from the MATLAB class is dropped in the python version.

Usage

Create ControlsClass by passing procedure. If no procedure is provided then it is set to Procedures.Calculate.

    calculate = ControlsClass() 
    dream = ControlsClass(procedure = Procedures.Dream)

Properties can be updated individually after ControlsClass is created.

    calculate.controls.calcSldDuringFit = True

Properties can also be set when ControlsClass is created by passing **kwargs.

    simplex = ControlsClass(procedure = Procedures.Simplex, tolX = 2e-5, maxIter = 500)