API

Members

Coming Soon!

Components

bolt Module

Structural steel Bolt Component Class.

This module defines classes for representing single structural steel bolt and bolt groups in a 2-column arrangement. It includes properties for geometry, material, and capacities calculations based on Australian standards and ASI design handbooks.

Bolt dataclass

Represents a single structural bolt, encapsulating both geometric data and capacity calculations according to specified standards (e.g., AS4100:1998, AS1275:1985).

Attributes
  • d_f (float) –

    Diameter of the bolt in mm. Defaults to 20.

  • bolt_cat (str) –

    Category of the bolt indicating its strength and type, e.g., '8.8/S'. Defaults to '8.8/S'.

  • threads_included (bool) –

    Flag indicating whether threads are included in the shear plane. Defaults to True.
Derived Attributes
  • name (str) –

    Descriptive name of the bolt, including diameter, category, and thread inclusion status.

  • bolt_des (str) –

    Brief description of the bolt, primarily indicating its diameter.

  • d_h (float) –

    Hole diameter in mm, standard bolt diameter according to AS4100:1998 CL 14.3.5.2.

  • a_e_min (float) –

    Minimum edge distance in mm, derived as per AS4100:1998 Table 9.6.2.

  • s_p_min (float) –

    Minimum pitch (spacing) in mm, derived according to AS4100:1998 CL 9.6.1.

  • phiV_f (float) –

    Design shear strength of the bolt in kN, calculated based on shear capacity factors.

  • phiN_tf (float) –

    Design tension strength of the bolt in kN, calculated based on tension capacity factors.

  • constr (str) –

    Constructor string in JSON format storing initial bolt configuration for easy reconstruction.

  • sig_figs (int) –

    Number of significant figures for rounding numerical outputs. Defaults to 3 and is used internally for output formatting.
phi_shear property 
phi_shear

Capacity factor for shear, AS4100 Table 3.4

phi_tension property 
phi_tension

Capacity factor for tension, AS4100 Table 3.4, AS4100 Cl 9.3.2.2

P property 
P

Bolt pitch, AS1275:1985 Table 3.2

A_c property 
A_c

Bolt core area, ASI Handbook1 Table 8; AS1275:1972 Cl 12a

A_s property 
A_s

Tensile stress area, ASI Handbook1 Table 8; AS1275:1985 Cl 1.7

A_o property 
A_o

Plain shank area, source: ASI Handbook 1 Table 8; AS1275:1985

f_uf property 
f_uf

Bolt tensile strength, property class 4.6 - AS1111.1:2000; property class 8.8 - AS/NZS1252:1996

k_r property 
k_r

Reduction factor for lap connection, AS4100 CL 9.3.2.1

N_tf property 
N_tf

Bolt nominal capacity in tension, AS4100:1998 CL 9.3.2.2

V_fx property 
V_fx

Bolt nominal capacity in shear (thread excluded), AS4100:1998 CL 9.3.2.1

V_fn property 
V_fn

Bolt nominal capacity in shear (thread included), AS4100:1998 CL 9.3.2.1

from_dict classmethod 
from_dict(**kwargs)

Constructs a Bolt object from a dictionary of attributes, allowing for dynamic creation based on varying specifications. Overriding default or derived attribute values otherwise calculated in post_init.

Parameters:
  • **kwargs –

    Arbitrary keyword arguments representing the attributes of a Bolt instance.
Returns:
  • Bolt( Bolt ) –

    An instance of the Bolt class, initialized with the specified attributes.
from_constr classmethod 
from_constr(constructor_str)

Constructs a Bolt object from a constructor string that contains a JSON representation of the bolt's configuration.

Parameters:
  • constructor_str (str) –

    A JSON string representation of the Bolt's configuration.
Returns:
  • Bolt( Bolt ) –

    An instance of the Bolt class, initialized based on the JSON string.

BoltGroup2D dataclass

Represents a 2-column bolts group, providing functionality for calculating geometric constraints, section properties, and shear capacities based on bolt arrangement and specifications.

Attributes
  • n_p (int) –

    Number of bolt rows parallel to the force direction, defaults to 7.

  • n_g (int) –

    Number of bolt columns perpendicular to the force direction, defaults to 2.

  • bolt (Bolt | str) –

    A Bolt instance or a constructor string representing the bolt used in the group, defaults to a default Bolt instance.

  • s_p (int) –

    Center-to-center spacing between bolts in a row (pitch) in mm, defaults to 70.

  • s_g (int) –

    Center-to-center spacing between bolts in a column (gauge) in mm, defaults to 70.

  • sig_figs (int) –

    Number of significant figures to use for rounding calculated values, defaults to 3.

Calculated Attributes (Not directly set by user): name (str): Automatically generated name for the bolt group based on its configuration. constr (str): JSON string representation of the bolt group's configuration for reconstruction. n_b (int): Total number of bolts in the group, calculated based on n_p and n_g. d_i_min (float): Minimum required depth for the bolt group based on edge distance considerations. phiV_df (float): Design shear strength of the bolt group in kN, calculated from the bolt's shear capacity and the number of bolts.

a_e_min property 
a_e_min

Minumum bolt holes edge distance

s_p_min property 
s_p_min

Minimum pitch

d_hp property 
d_hp

Centre-to-centre depth between top-most and bottom-most bolt holes

d_hg property 
d_hg

Centre-to-centre depth between inner-most and outer-most bolt holes

a_ex_bc property 
a_ex_bc

Horizontal plate tear-out length, bolt centre to adjacent hole edge

a_ey_bc property 
a_ey_bc

Vertical plate tear-out length, bolt centre to adjacent hole edge

bolt_name property 
bolt_name

Generate unique bolt name

bolt_constr property 
bolt_constr

Generate constructor string

a_ey 
a_ey(a_ev_e)

Vertical plate tear-out length

a_ex 
a_ex(a_eh_e)

Horizontal plate tear-out length

l_vy 
l_vy(a_ev_e)

Block shear path parallel to vertical shear force, ASI Handbook1 section 5.4 Figure 50, ASI Design Guide 4 Fig.14

l_ty 
l_ty(a_eh_e)

Block shear path perpendicular to vertical shear force, ASI Handbook1 section 5.4 Figure 50

l_vx 
l_vx(a_eh_e)

Block shear path parallel to horizontal tension force, ASI Handbook1 section 5.4 Figure 50

l_tx property 
l_tx

Block shear path perpendicular to horizontal tension force, ASI Handbook1 section 5.4 Figure 50

_phiV_df 
_phiV_df()

Bolt group shear capacty, AS4100:1998 CL 9.3.2.1

from_constr classmethod 
from_constr(constructor_str)

Constructs a BoltGroup2D object from a constructor string that contains the JSON representation of the bolt group's configuration.

Parameters:
  • constructor_str (str) –

    A JSON string representing the configuration of the bolt group. It should include keys for 'n_p', 'n_g', 'bolt' (as a JSON string or dict that can be passed to Bolt.from_constr if necessary), 's_p', and 's_g'.
Returns:
  • BoltGroup2D –

    An instance of the BoltGroup2D class initialized with the parameters extracted from the JSON string.
from_dict classmethod 
from_dict(**kwargs)

Constructs a BoltGroup2D object from a dictionary of parameters.

This method differs from direct initialization as it can handle special cases like converting a constructor string for a 'bolt' into a Bolt object.

Parameters:
  • **kwargs –

    Arbitrary keyword arguments that represent the attributes of the BoltGroup2D class. Special handling for 'bolt_constr' key exists, where the value is expected to be a constructor string that can be passed to Bolt.from_constr to create a Bolt instance.
Returns:
  • BoltGroup2D –

    An instance of the BoltGroup2D class initialized with the parameters provided in the dictionary. If 'bolt_constr' is provided, it is used to initialize the 'bolt' attribute as a Bolt instance.
phiV_df_ecc 
phiV_df_ecc(e)

Bolt group shear capacty with eccentricity,AS4100:1998 CL 9.3.2.1

plate Module

Structural Steel Plate Component Class.

This module defines the Plate class for representing a structural steel plate, including its dimensions, material properties, and various capacity calculations based on Australian standards and ASI design handbooks.

Plate dataclass

A class to represent a structural steel plate, encapsulating dimensions, material grade, and providing methods to calculate its structural capacities.

Attributes
  • b_i (int) –

    Width of the plate in mm. Defaults to 200.

  • t_i (int) –

    Thickness of the plate in mm. Defaults to 10.

  • plate (str) –

    Description of the plate including material grade. Defaults to 'Plate GR250'.
Derived Attributes
  • name (str) –

    Descriptive name of the plate, including its dimensions and material grade.

  • constr (str) –

    Constructor string in JSON format for easy reconstruction of the plate object.

  • plate_type (str) –

    Type of the plate derived from the plate attribute.

  • plate_grade (str) –

    Material grade of the plate derived from the plate attribute.

  • f_ui (int) –

    Ultimate tensile strength of the plate material in MPa.

  • f_yi (int) –

    Yield strength of the plate material in MPa.

  • sig_figs (int) –

    Number of significant figures for rounding calculated values.
phi_shear property 
phi_shear

capacity factor for shear, AS4100:1998 Table 3.4

phi_bending property 
phi_bending

capacity factor for bending, AS4100:1998 Table 3.4

phi_bearing property 
phi_bearing

capacity factor for ply bearing, AS4100:1998 Table 3.4

phi_block_shear property 
phi_block_shear

capacity factor for block shear, ANSI/AISC 360-16 J4.3

phiV_bb 
phiV_bb(n_b, d_f, t_p, f_u)

ply in bearing (local bearing failure), AS4100 9.3.2.4(1)

phiV_bt 
phiV_bt(n_b, a_e, t_p, f_u)

ply in bearing (tear-out failure), AS4100 9.3.2.4(2)

phiV_v 
phiV_v(d_i)

plate shear capacity, AS4100:1998 CL 5.11.3, 5.11.4; ASI Handbook1 CL 5.4

phiM_si 
phiM_si(d_i)

plate moment capacity, AS4100 CL 5.2.1; ASI Handbook 1 CL 5.4

phiM_si_ecc 
phiM_si_ecc(d_i, e)

plate moment capacity with eccentricity

A_nt 
A_nt(l_t)

net area in horizontal block shear, ASI Handbook1 Fig. 50

A_gv 
A_gv(l_v)

gross area in vertical direction block shear, ASI Handbook1 Fig. 50

phiV_bs 
phiV_bs(l_t, l_v)

plate block shear capacity, ANSI/AISC 360-16 J4.3; ASI Handbook section 5.4

from_dict classmethod 
from_dict(**kwargs)

Constructs a Plate object from a dictionary of attributes, allowing for dynamic creation based on varying specifications. Overrides derived attribute values otherwise calculated in post_init.

Parameters:
  • **kwargs –

    Arbitrary keyword arguments corresponding to Plate attributes.
Returns:
  • Plate –

    An initialized Plate object based on the provided attributes.
from_constr classmethod 
from_constr(constructor_str)

Constructs a Plate object from a constructor string that contains a JSON representation of the plate's configuration.

Parameters:
  • constructor_str (str) –

    JSON string representation of the Plate's configuration.
Returns:
  • Plate( Plate ) –

    An initialized Plate object based on the JSON string.

weld Module

Structural Steel Weld Component Class.

This module defines the Weld class for representing a structural steel weld, including its dimensions, geometry, material properties, and various capacity calculations based on Australian standards and ASI design handbooks.

Weld dataclass

Represents a structural steel weld, encapsulating its dimensions, type, category, class, and providing methods for capacity calculations.

Attributes
  • t_w (int) –

    Leg size of the fillet weld in mm.

  • weld_type (str) –

    Type of weld, e.g., 'CFW' for continuous fillet weld.

  • weld_cat (str) –

    Category of the weld, e.g., 'SP' for specific purpose.

  • weld_class (str) –

    Class of the weld electrode, e.g., 'E48XX'.
Derived Attributes
  • phiv_w (float) –

    Design capacity of the weld per unit length in kN/mm, calculated post-initialization.

  • name (str) –

    Descriptive name of the weld, combining its dimensions, type, category, and class.

  • constr (str) –

    Constructor string in JSON format storing the weld's initial configuration.

  • sig_figs (int) –

    Number of significant figures for rounding calculated values.

The class includes properties to derive critical weld parameters like design throat thickness, nominal weld capacity, and capacity factors based on standards such as AS4100:1998.

t_t property 
t_t

design throat thickness, AS4100:1998 CL 9.7.3.1

v_w property 
v_w

nominal capacity of fillet weld per unit length, AS4100 CL 9.7.3.10

phi property 
phi

capacity factor for weld category, AS4100 Table 3.4, AS4100:1998 CL 9.7.3.10

f_uw property 
f_uw

nominal tensile strength of weld metal, ASI Handbook1 Table 22, AS4100 Table 9.7.3.10(1)

k_r property 
k_r

reduction factor for a welded lap connection, AS4100:1998 Table 9.7.3.10(2)

V_a 
V_a(d_i)

weld capacity on plate, ASI Design Guide 4 section 10.2

V_a_ecc 
V_a_ecc(d_i, e)

weld capacity on plate, ASI Design Guide 5 section 10.2

from_dict classmethod 
from_dict(**kwargs)

Constructs a Weld object from a dictionary of attributes, allowing for dynamic creation based on varying specifications.

Parameters:
  • **kwargs –

    Arbitrary keyword arguments corresponding to Weld attributes.
Returns:
  • Weld –

    An initialized Weld object based on the provided attributes.
from_constr classmethod 
from_constr(constructor_str)

Constructs a Weld object from a constructor string that contains a JSON representation of the weld's configuration.

Parameters:
  • constructor_str (str) –

    JSON string representation of the Weld's configuration.
Returns:
  • Weld( Weld ) –

    An initialized Weld object based on the JSON string.

Connections

FEP Module

Flexible End Plate Connection Design Module

This module focuses on the detailed design of Flexible End Plate (FEP) connections. It incorporates classes that represent various components of steel connections, such as bolt groups, welds, plates, and specifically featured members.

This class performs a series of structural capacity calculations and detailing checks based on ASI Design Guide 4: Flexible end plate connections. The checks include analyses for weld to web in shear, bolt shear plus plate bearing, plate shear, plate block shear/tear-out, supported member web shear, supported member shear, and bending checks for coped members in eccentric load connections.

Connection dataclass

Represents a generic parent class for simple steel connections.

This base class is intended to be extended by specific connection types, providing common attributes and methods that are applicable across various connection designs. It serves as a foundation for more specialized connection classes, encapsulating shared logic and properties.

FEPConnection dataclass

Represents a Flexible End Plate (FEP) connection. This class includes specific properties and methods relevant to FEP connections detailing checks and structural capacity.

Attributes
  • featured_member (FeaturedMember) –

    The featured member involved in the connection.

  • bolt_group (BoltGroup2D) –

    The bolt group used in the connection.

  • plate (Plate) –

    The plate used in the connection.

  • weld (Weld) –

    The weld details used in the connection.

  • conn_type (str) –

    Type of the connection, defaulting to 'FEP'.

  • a (float) –

    Vertical offset to the top bolt center, in mm.

  • a_ev_e (float) –

    Vertical edge distance from the bolt hole center to the edge, in mm.

  • detailing_OK (bool) –

    Flag indicating if the connection detailing checks pass.

  • d_i (float) –

    Derived attribute for the effective depth of the connection.

  • a_eh_e (float) –

    Horizontal edge distance, derived attribute.

  • sig_figs (int) –

    Number of significant figures for rounding calculations, defaults to 4.

  • V_a (float) –

    Weld to web in shear capacity, from the supported member to the weld.

  • V_b (float) –

    Bolt shear plus plate bearing capacity, from the plate to the bolt group.

  • V_c (float) –

    Plate in shear capacity.

  • V_d (float) –

    Plate block shear/tear-out capacity, for plates with bolt holes.

  • V_e (float) –

    Supported member web shear capacity.

  • V_f (float) –

    Supported member shear capacity.

  • V_g (float) –

    Coped member bending check capacity, for eccentric connection loads.

  • V_des_ASI (float) –

    Governing capacity of V_a to V_f, ensuring compliance with ASI Design Guide criteria.

  • V_des_all (float) –

    Governing capacity of V_a to V_g, providing a comprehensive overview of the connection's capacity.
long_name property 
long_name

returns a (long) name string by concatenating member + component names

name_constr 
name_constr()

returns a function that constructs a

short_name 
short_name(short_id)

returns a short name string, using the defined name_constr function

WSP Module

Web Side Plate Connection Design Module

This module is dedicated to the detailed design of Web Side Plate (WSP) connections. It features a comprehensive suite of classes that represent various components of steel connections, including bolt groups, welds, plates, and specifically featured members that may have modifications affecting their structural performance. This class performs a series of structural capacity calculations and detailing checks based on ASI Design Guide 3: Web side plate connections.

WSPConnection dataclass

Represents a Welded Side Plate (WSP) Connection. This class includes specific properties and methods relevant to WSP connections detailing checks and structural capacity.

Attributes
  • featured_member (FeaturedMember) –

    The featured member involved in the connection.

  • bolt_group (BoltGroup2D) –

    The bolt group used in the connection.

  • plate (Plate) –

    The plate used in the connection.

  • weld (Weld) –

    The weld details used in the connection.

  • conn_type (str) –

    Type of the connection, defaulting to 'WSP'.

  • a (float) –

    Vertical offset to the top bolt center, in mm.

  • a_ev_e (float) –

    Vertical edge distance from the bolt hole center to the edge, in mm.

  • detailing_OK (bool) –

    Flag indicating if the connection detailing checks pass.

  • d_i (float) –

    Derived attribute for the effective depth of the connection.

  • a_eh_e (float) –

    Horizontal edge distance, derived attribute.

  • sig_figs (int) –

    Number of significant figures for rounding calculations, defaults to 4.

  • V_a (float) –

    Weld to web in shear capacity, from the supporting member to the weld.

  • V_b (float) –

    Bolt shear plus plate bearing and member bearing capacity, from the supported member to bolts to plate.

  • V_c (float) –

    Plate in shear capacity.

  • V_d (float) –

    Plate bending capacity.

  • V_e (float) –

    Plate block shear/tear-out capacity.

  • V_f (float) –

    Supported member shear capacity.

  • V_g (float) –

    Coped member block shear capacity.

  • V_h (float) –

    Coped member bending in eccentric load connections.

  • V_des_ASI (float) –

    Governing capacity from V_a to V_g, ensuring compliance with ASI Design Guide criteria.

  • V_des_all (float) –

    Governing capacity from V_a to V_h, providing a comprehensive overview of the connection's capacity.
long_name property 
long_name

returns a (long) name string by concatenating member + component names

name_constr 
name_constr()

returns a function that constructs a

short_name 
short_name(short_id)

returns a short name string, using the defined name_constr function