Skip to content

borealis

borealis

new_file(exp_id='')

New file.

Source code in borealis/__init__.py 
70
71
72
def new_file(exp_id: str = ''):
    """New file."""
    session_data_collector.create_h5file(experiment_id=exp_id)

new_sample(sample)

New sample.

Parameters:

Name Type Description Default
sample str
required
Source code in borealis/__init__.py 
75
76
77
78
79
80
81
82
def new_sample(sample: str):
    """New sample.

    Parameters
    ----------
    sample : str
    """
    session_data_collector.current_sample = sample

scan(scan_motor, data_point, acq_time)

Master scan function.

Parameters:

Name Type Description Default
scan_motor Union[Motor, PseudoMotor]

Instance of Motor or Pseudo-motor to scan

 required
data_point Iterable[float]
required
acq_time float
required
Source code in borealis/__init__.py 
85
86
87
88
89
90
91
92
93
94
95
96
def scan(scan_motor: Union['Motor', 'PseudoMotor'], data_point: Iterable[float], acq_time: float):
    """Master scan function.

    Parameters
    ----------
    scan_motor : Union[Motor, PseudoMotor]
        Instance of Motor or Pseudo-motor to scan
    data_point : Iterable[float]
    acq_time : float

    """
    session_orchestrator.scan(scan_motor, data_point, acq_time)