SimCATS

Examples

  • Example notebook for the usage of the SimCATS simulation class
    • Imports
    • Retrieve a default configuration
    • Initialize an instance of the Simulation class using the retrieved config
    • Perform measurements
      • 2D simulation
        • Perform a measurement of the full voltage range
        • Plot the results
      • 2D simulation with a different sensor
        • Setup a new sensor and update the simulation configuration
        • Perform a measurement
        • Plot the results
      • 2D Simulation of small regions (with the first/old sensor)
        • Set the sensor configuration to the old sensor
        • Perform a measurement
        • Plot the results
      • 1D simulation
        • Perform a measurement
        • Plot the results
  • Example notebook for the SimCATS class IdealCSDGeometric and related functions
    • Imports
    • Total Charge Transitions (TCTs)
      • Total Charge Transition (TCT) parameters
      • Evaluation/Calculation of the TCT
      • Representation with and without tunnel coupling / rounding of interdot transitions
        • Retrieve all bezier anchors of the TCT & set up representation with no tunnel coupling / rounding of interdot transitions
        • Plot the TCT curves with and without tunnel coupling and annotate the parameters necessary to generate/define the TCT.
      • Rotation of TCTs into the actual voltage space
      • Controlling the number of interdot transitions using the parameter max_peaks
      • Generating further TCTs by shifting waveforms according to known interdot vector
    • 2D simulation
      • Step by step
        • Set up lead transitions
        • Calculate occupations using the lead transition mask
      • All-in-one method
    • 1D simulation
      • Step by step
        • Calculate occupation using the TCTs
        • Calculate lead transition from occupation
      • All-in-one method
    • Simulation of the interdot transition (using CDFs)
      • Cauchy CDF
      • Sigmoid/Logistic CDF
    • Extraction of labels
  • Example notebook for the usage of SensorScanSensor class of SimCATS
    • Imports
    • Retrieve a default configuration
    • Initialize an instance of the Simulation class using the retrieved config
    • Perform measurements
      • 2D simulation
        • Sensor scan
          • Perform a measurement of a large voltage range
          • Plot the results
        • CSDs
          • Perform a measurement of the full voltage range
          • Plot the results
      • 1D simulation
        • Sensor scan
          • Perform a measurement
          • Plot the results
        • CSDs
          • Perform a measurement
          • Plot the results
      • 2D simulation with a different sensor
        • Setup of a new sensor
          • Alpha leverarms
          • Sensor peak function and final rise
            • Sensor deformation
          • Barrier functions
        • Update the simulation configuration
        • Sensor scan
          • Perform a measurement of a large voltage range
          • Plot the results
        • CSDs
          • Perform a measurement of the full voltage range
          • Plot the results
      • 2D Simulation with a sampled sensor
        • Sample a new sensor config
        • Sensor scan
          • Perform a measurement over a large voltage range
          • Plot the results
        • CSDs
          • Plot the results

API Reference

  • simcats
    • Subpackages
      • simcats.config_samplers
        • Package Contents
          • Functions
        • Package Implementation Details
          • sample_random_variations_v3_config()
      • simcats.distortions
        • Package Contents
          • Classes
          • Functions
        • Package Implementation Details
          • DistortionInterface
            • DistortionInterface.noise_function()
          • OccupationDistortionInterface
            • OccupationDistortionInterface.noise_function()
          • SensorPotentialDistortionInterface
            • SensorPotentialDistortionInterface.noise_function()
          • SensorResponseDistortionInterface
            • SensorResponseDistortionInterface.noise_function()
          • OccupationTransitionBlurringGaussian
            • OccupationTransitionBlurringGaussian.sigma
            • OccupationTransitionBlurringGaussian.latest_sigma
            • OccupationTransitionBlurringGaussian.noise_function()
          • OccupationTransitionBlurringFermiDirac
            • OccupationTransitionBlurringFermiDirac.sigma
            • OccupationTransitionBlurringFermiDirac.latest_sigma
            • OccupationTransitionBlurringFermiDirac.noise_function()
          • OccupationDotJumps
            • OccupationDotJumps.scale
            • OccupationDotJumps.lam
            • OccupationDotJumps.axis
            • OccupationDotJumps.ratio
            • OccupationDotJumps.rng
            • OccupationDotJumps.activated
            • OccupationDotJumps.noise_function()
          • dot_jumps_blockwise()
          • SensorPotentialPinkNoise
            • SensorPotentialPinkNoise.sigma
            • SensorPotentialPinkNoise.fmin
            • SensorPotentialPinkNoise.rng
            • SensorPotentialPinkNoise.latest_sigma
            • SensorPotentialPinkNoise.noise_function()
          • pink_gaussian_noise()
          • RandomTelegraphNoise
            • RandomTelegraphNoise.scale
            • RandomTelegraphNoise.std
            • RandomTelegraphNoise.height
            • RandomTelegraphNoise.ratio
            • RandomTelegraphNoise.rng
            • RandomTelegraphNoise.activated
            • RandomTelegraphNoise.noise_function()
          • SensorPotentialRTN
            • SensorPotentialRTN.noise_function()
            • SensorPotentialRTN.scale
            • SensorPotentialRTN.std
            • SensorPotentialRTN.height
            • SensorPotentialRTN.ratio
            • SensorPotentialRTN.rng
            • SensorPotentialRTN.activated
          • SensorResponseRTN
            • SensorResponseRTN.noise_function()
            • SensorResponseRTN.scale
            • SensorResponseRTN.std
            • SensorResponseRTN.height
            • SensorResponseRTN.ratio
            • SensorResponseRTN.rng
            • SensorResponseRTN.activated
          • random_telegraph_noise()
          • SensorResponseWhiteNoise
            • SensorResponseWhiteNoise.rng
            • SensorResponseWhiteNoise.sigma
            • SensorResponseWhiteNoise.latest_sigma
            • SensorResponseWhiteNoise.noise_function()
          • white_gaussian_noise()
      • simcats.ideal_csd
        • Subpackages
          • simcats.ideal_csd.geometric
            • Package Contents
              • Functions
            • Package Implementation Details
              • tct_bezier()
              • initialize_tct_functions()
              • calculate_all_bezier_anchors()
              • generate_lead_transition_mask_1d()
              • generate_lead_transition_mask_2d()
              • get_electron_occupation()
              • ideal_csd_geometric()
        • Package Contents
          • Classes
        • Package Implementation Details
          • IdealCSDInterface
            • IdealCSDInterface.get_csd_data()
          • IdealCSDGeometric
            • IdealCSDGeometric.tct_params
            • IdealCSDGeometric.rotation
            • IdealCSDGeometric.lut_entries
            • IdealCSDGeometric.cdf_type
            • IdealCSDGeometric.cdf_gamma_factor
            • IdealCSDGeometric.get_csd_data()
      • simcats.sensor
        • Subpackages
          • simcats.sensor.barrier_function
            • Package Contents
              • Classes
            • Package Implementation Details
              • BarrierFunctionInterface
                • BarrierFunctionInterface.get_value()
                • BarrierFunctionInterface.pinch_off
                • BarrierFunctionInterface.fully_conductive
              • BarrierFunctionGLF
                • BarrierFunctionGLF.pinch_off_percentage
                • BarrierFunctionGLF.fully_conductive_percentage
                • BarrierFunctionGLF.asymptote_left
                • BarrierFunctionGLF.asymptote_right
                • BarrierFunctionGLF.growth_rate
                • BarrierFunctionGLF.asymmetry
                • BarrierFunctionGLF.shape_factor
                • BarrierFunctionGLF.denominator_offset
                • BarrierFunctionGLF.offset
                • BarrierFunctionGLF.get_value()
                • BarrierFunctionGLF.pinch_off
                • BarrierFunctionGLF.fully_conductive
              • BarrierFunctionMultiGLF
                • BarrierFunctionMultiGLF.pinch_off
                • BarrierFunctionMultiGLF.fully_conductive
                • BarrierFunctionMultiGLF.params
                • BarrierFunctionMultiGLF.get_value()
          • simcats.sensor.deformation
            • Package Contents
              • Classes
            • Package Implementation Details
              • SensorPeakDeformationInterface
                • SensorPeakDeformationInterface.calc_mu()
                • SensorPeakDeformationInterface.sensor
              • SensorPeakDeformationCircle
                • SensorPeakDeformationCircle.radius
                • SensorPeakDeformationCircle.calc_mu()
              • SensorPeakDeformationLinear
                • SensorPeakDeformationLinear.angle
                • SensorPeakDeformationLinear.calc_mu()
        • Package Contents
          • Classes
          • Functions
        • Package Implementation Details
          • SensorPeakInterface
            • SensorPeakInterface.mu0
            • SensorPeakInterface.sensor_function()
          • SensorRiseInterface
            • SensorRiseInterface.fully_conductive
            • SensorRiseInterface.sensor_function()
          • SensorInterface
            • SensorInterface.sensor_response()
            • SensorInterface.sensor_potential()
          • SensorScanSensorInterface
            • SensorScanSensorInterface.sensor_potential()
            • SensorScanSensorInterface.get_sensor_scan_labels()
            • SensorScanSensorInterface.sensor_response()
          • SensorPeakGaussian
            • SensorPeakGaussian.mu0
            • SensorPeakGaussian.sigma
            • SensorPeakGaussian.height
            • SensorPeakGaussian.offset
            • SensorPeakGaussian.sensor_function()
          • sensor_response_gauss()
          • SensorPeakLorentzian
            • SensorPeakLorentzian.mu0
            • SensorPeakLorentzian.gamma
            • SensorPeakLorentzian.height
            • SensorPeakLorentzian.offset
            • SensorPeakLorentzian.sensor_function()
          • sensor_response_lorentz()
          • SensorRiseGLF
            • SensorRiseGLF.mu0
            • SensorRiseGLF.asymptote_left
            • SensorRiseGLF.asymptote_right
            • SensorRiseGLF.growth_rate
            • SensorRiseGLF.asymmetry
            • SensorRiseGLF.shape_factor
            • SensorRiseGLF.denominator_offset
            • SensorRiseGLF.fully_conductive_percentage
            • SensorRiseGLF.fully_conductive
            • SensorRiseGLF.sensor_function()
          • SensorGeneric
            • SensorGeneric.sensor_peak_function
            • SensorGeneric.alpha_dot
            • SensorGeneric.alpha_gate
            • SensorGeneric.offset_mu_sens
            • SensorGeneric.sensor_response()
            • SensorGeneric.sensor_potential()
          • SensorScanSensorGeneric
            • SensorScanSensorGeneric.sensor_peak_function
            • SensorScanSensorGeneric.sensor_peak_deformations
            • SensorScanSensorGeneric.final_rise
            • SensorScanSensorGeneric.alpha_dot
            • SensorScanSensorGeneric.alpha_gate
            • SensorScanSensorGeneric.alpha_sensor_gate
            • SensorScanSensorGeneric.offset_mu_sens
            • SensorScanSensorGeneric.barrier_functions
            • SensorScanSensorGeneric.sensor_response()
            • SensorScanSensorGeneric.sensor_potential()
            • SensorScanSensorGeneric.get_sensor_scan_labels()
      • simcats.support_functions
        • Package Contents
          • Classes
          • Functions
        • Package Implementation Details
          • ParameterSamplingInterface
            • ParameterSamplingInterface.sample_parameter()
            • ParameterSamplingInterface.last_sample()
          • NormalSamplingRange
            • NormalSamplingRange.sample_parameter()
            • NormalSamplingRange.last_sample()
          • LogNormalSamplingRange
            • LogNormalSamplingRange.sample_parameter()
            • LogNormalSamplingRange.last_sample()
          • UniformSamplingRange
            • UniformSamplingRange.sample_parameter()
            • UniformSamplingRange.last_sample()
          • ExponentialSamplingRange
            • ExponentialSamplingRange.sample_parameter()
            • ExponentialSamplingRange.last_sample()
          • fermi_filter1d()
          • fermi_dirac_derivative()
          • cauchy_cdf()
          • multi_cauchy_cdf()
          • sigmoid_cdf()
          • multi_sigmoid_cdf()
          • glf()
          • inverse_glf()
          • multi_glf()
          • reset_offset_mu_sens()
          • signed_dist_points_line()
          • line_line_intersection()
          • line_circle_intersection()
          • is_point_below_line()
          • pixel_to_volt_1d()
          • rotate_points()
          • plot_csd()
    • Package Contents
      • Classes
      • Attributes
    • Package Implementation Details
      • Simulation
        • Simulation.volt_limits_g1
        • Simulation.volt_limits_g2
        • Simulation.volt_limits_sensor_g1
        • Simulation.volt_limits_sensor_g2
        • Simulation.ideal_csd_config
        • Simulation.sensor
        • Simulation.occupation_distortions
        • Simulation.sensor_potential_distortions
        • Simulation.sensor_response_distortions
        • Simulation.measure()
        • Simulation.measure_sensor_scan()
      • default_configs
SimCATS
  • Search

© Copyright 2026 Peter Grünberg Institute - Integrated Computing Architectures (ICA / PGI-4), Forschungszentrum Jülich GmbH.

Built with Sphinx using a theme provided by Read the Docs.