Accompanying the HLF Libraries is a comprehensive set of documentation. The documentation, amongst other things, provides:
- A description of each available function and method
- Guidance on the required parameters, their relevant data types and default values (when prescribed) per function call
- The expected return type (if relevant)
Over and above the guidance from the documentation, we have prepared a diverse range of example scripts. The example scripts can be viewed as an additional resource which provides an illustration of correct function implementation as well as inspiration for your coding projects.
The purpose of this Online Manual is to provide all the required information necessary for programming with RFEM6/RSTAB9 and Python. However, since the documentation and example scripts provides a great depth of content pertaining to the actual interaction (function calls, syntactical demands and parameter inputs), this information is not repeated here and we strongly referring referring to the above-mentioned resources.
Some key points to note, when working with our HLF Libraries:
- The folder structure of the libraries mimics the graphical user interface of RFEM6/RSTAB9;
- Classes can be initialized with the name of the class itself. This initialization defines a default RFEM6/RSTAB9 object. For example, the member class will by default initialize a member of type beam. This is also what one sees by default when creating a member in RFEM6/RSTAB9. Function call using the name of the class itself:
Member()
- Accessing further functions of this member class (with simple dot notation), provides further functionality:
Member.Beam()
Member.Buckling()
Member.Cable()
Member.Compression()
...
Member.TrussOnlyN()
- All element numbering (sections, materials, nodes, members, loads and load cases etc.) needs to be sequential and free of gaps; and
- Sections and materials which are defined in the RFEM6/RSTAB9 Database can be directly accessed by an appropriate string in Python. The string needs to be exactly as per definition in the database. Refer to RFEM6/RSTAB9 for the required string. Examples below:
Material(1, 'S235')
Section(1, 'IPE 200')