5.1. Initialisation

calibration.__init__(nst, sdof_capacity, is_sos=False, storey_heights=None, stiffness_profile=None, mass_profile=None, phi_target=None, roof_mass_factor=0.75, soft_storey_factor=None, stiffness_group_size=2, validate_results=True, verbose=False)[source]

Initialise the calibration object and validate inputs.

Parameters:

  • nst (int) – Number of storeys. Must be a positive integer.

  • sdof_capacity (numpy.ndarray) – SDOF capacity array [Sd (m), Sa (g)], shape (n, 2). Must not include (0, 0) rows and must contain at least 2 non-zero points.

  • is_sos (bool, optional) – True if a soft-storey system. Reduces the ground-floor stiffness by soft_storey_factor. Default is False.

  • storey_heights (list of float, optional) – Storey heights in metres, length nst. When provided, triggers OpenSees period-matching and SPO verification inside calibrate_model(). Default is None.

  • stiffness_profile (numpy.ndarray, optional) – Custom relative storey stiffnesses (length nst). Overrides the default decay profile. Default is None.

  • mass_profile (numpy.ndarray, optional) – Custom floor masses (length nst, should sum to 1.0). Overrides the default mass distribution. Default is None.

  • phi_target (numpy.ndarray, optional) – Custom first mode shape (length nst, roof-normalised). Overrides the eigenvalue-based mode shape. Default is None.

  • roof_mass_factor (float, optional) – Ratio of roof mass to typical floor mass. Default is 0.75.

  • soft_storey_factor (float, optional) – Multiplicative reduction for the ground-floor stiffness when is_sos is True. If None, defaults to 0.35 for soft-storey systems and 0.50 otherwise.

  • stiffness_group_size (int, optional) – Number of storeys per stiffness group. Default is 2.

  • validate_results (bool, optional) – If True, capacity curves are validated for monotonicity and positive values after calibration. Default is True.

  • verbose (bool, optional) – If True, print calibration progress to console. Default is False.

Raises:

  • TypeError – If any input has an incorrect type.

  • ValueError – If any input has an invalid value or inconsistent dimensions.