Releases#

All notable changes to the Dlubal API will be documented in this file, categorized by version number.

The changes can be categorized further in the following headers:

  • Action Required: when a backwards incompatible change is made, which requires actions in the application code.

  • Added: when a functionality is added, without breaking compatibility with older versions.

  • Fixed: when the change fixes a bug/error.

  • Deprecated: when an existing functionality will be removed in upcoming releases.

  • Docs: when the change involves SDK documentation, docstring, and/or type hinting.

2.12.5 - 03/11/2025#

Added

  • Extended ResultTypes enums for get_results() method completing the results for surfaces and solids:

    # All relevant analyses (grid/mesh)
SURFACES_BASIC_STRESSES
SURFACES_BASIC_TOTAL_STRAINS
SURFACES_PRINCIPAL_TOTAL_STRAINS
SURFACES_PRINCIPAL_INTERNAL_FORCES
SURFACES_DESIGN_INTERNAL_FORCES
SURFACES_ELASTIC_STRESS_COMPONENTS
SURFACES_EQUIVALENT_STRESSES
SURFACES_EQUIVALENT_TOTAL_STRAINS
SURFACES_MAXIMUM_TOTAL_STRAINS
SOLIDS_BASIC_PLASTIC_STRAINS
SOLIDS_BASIC_STRESSES
SOLIDS_BASIC_TOTAL_STRAINS
SOLIDS_DEFORMATIONS
SOLIDS_EQUIVALENT_PLASTIC_STRAINS
SOLIDS_EQUIVALENT_STRESSES
SOLIDS_EQUIVALENT_TOTAL_STRAINS
SOLIDS_PRINCIPAL_PLASTIC_STRAINS
SOLIDS_PRINCIPAL_STRESSES
SOLIDS_PRINCIPAL_TOTAL_STRAINS
Fixed

  • Fixed retrieving results on Result Beam using the get_results() method.

2.12.4 - 27/10/2025#

(No changes)

2.12.3 - 20/10/2025#

Action Required

  • Renamed submodules types_for_xxx_design to xxx_design for all the design addons:

    # Before
rfem.types_for_steel_design.SteelEffectiveLengths
# After
rfem.steel_design.SteelEffectiveLengths
Added

  • Introduced set of attributes active_for_xxx to allow activate/deactive specific design addon/s to be calculated within a DesignSituation.

Fixed

  • Fixed columns data types in the Pandas DataFrame returned by the get_result_table() method.

  • Fixed duplicate rows when LineSupport.DiagramAlongXTable is created/updated.

Docs

  • Added clarification that Core methods contribute to the API limit, whereas Service methods do not, as explained in each method’s documentation.

2.12.2 - 13/10/2025#

Added

  • Enhanced the get_results() implementation in the C# client to support the ResultsFilters parameter for result filtering.

Fixed

  • Restored the convert_objects() method in the C# client.

  • Restored the select_objects() method in the C# client.

2.12.1 - 06/10/2025#

Added

  • Extended save_model() to allow decision whether model should be saved with results, mesh or printout reports.

  • Introduced get_subscription_info() to display API request usage and subscription limits.

  • Completed access to model objects and their attributes.

2.11.12 - 29/09/2025#

Action Required

  • Change ouptut object from get_results() and get_result_table() method to Common.Table encapsulating Microsoft DataFrame:

    # Before
Microsoft.Data.Analysis.DataFrame results = await RfemApp.get_results(...);
# After
Common.Table results = await RfemApp.get_results(...);
Microsoft.Data.Analysis.DataFrame df = results.Data;

  • Renamed nodal_support_coordinate_system to support_coordinate_system since it’s now valid for nodal and line support reaction:

    # Before
rfem_app.get_results(
  nodal_support_coordinate_system = rfem.results.settings.COORDINATE_SYSTEM_LOCAL
)
# After
rfem_app.get_results(
  support_coordinate_system = rfem.results.settings.COORDINATE_SYSTEM_LOCAL
)
Added

  • Extended import_from() to support XML file via attribute XmlImportAttributes.

  • Extended ResultTypes enums for get_results() method to support additional results:

    # Stability analysis
STABILITY_ANALYSIS_LOAD_CRITICAL_FACTOR

  • Extended ResultTable enums for get_result_table() method to support additional results:

    # Modal analysis
MODAL_ANALYSIS_NATURAL_FREQUENCIES_TABLE
MODAL_ANALYSIS_PARTICIPATION_FACTORS_TABLE
MODAL_ANALYSIS_EFFECTIVE_MODAL_MASSES_TABLE
MODAL_ANALYSIS_MASSES_IN_LOCATIONS_TABLE
MODAL_ANALYSIS_xxx_BY_MODE_SHAPE_TABLE
MODAL_ANALYSIS_MODE_SHAPES_BY_xxx_TABLE
# Stability analysis
STABILITY_ANALYSIS_CRITICAL_LOAD_FACTORS_TABLE
STABILITY_ANALYSIS_EFFECTIVE_LENGTHS_AND_CRITICAL_LOADS_BY_MEMBER_TABLE
STABILITY_ANALYSIS_MEMBERS_INTERNAL_FORCES_BY_MODE_SHAPE_TABLE
STABILITY_ANALYSIS_MODE_SHAPES_BY_xxx_TABLE
STABILITY_ANALYSIS_xxx_BY_MODE_SHAPE_TABLE

  • Enhanced get_result_table() by adding the parameters support_coordinate_system and member_axes_system to specify the coordinate system used when retrieving results for supports or members.

2.11.11 - 15/09/2025#

Action Required

  • Moved all the standard-related settings to the BaseData.Standards location:

    # Before
BaseData.CombinationsSettings.combination_wizard_standard
# After
BaseData.Standards.combination_wizard_standard
Added

  • Enahnced BaseData.Main object to contain additional model attributes (model_type, …).

  • Extended ResultTypes enums for get_results() method to support additional results:

    # All relevant analyses
LINES_SUPPORT_FORCES
# All relevant analyses (grid/mesh)
SURFACES_BASIC_STRESSES
SURFACES_LOCAL_DEFORMATIONS
SURFACES_GLOBAL_DEFORMATIONS
SOLIDS_DEFORMATIONS
SOLIDS_BASIC_TOTAL_STRAINS
SOLIDS_PRINCIPAL_TOTAL_STRAINS
SOLIDS_EQUIVALENT_TOTAL_STRAINS
SOLIDS_BASIC_PLASTIC_STRAINS
SOLIDS_PRINCIPAL_PLASTIC_STRAINS
SOLIDS_EQUIVALENT_PLASTIC_STRAINS
# Modal analysis
MODAL_ANALYSIS_NATURAL_FREQUENCIES
MODAL_ANALYSIS_EFFECTIVE_MODAL_MASSES
MODAL_ANALYSIS_PARTICIPATION_FACTORS

  • Introduced get_design_settings() and set_design_settings() methods for global configuration of design add-ons.

  • Added the Common.TreeHelpers class to the C# client with helper functions for handling model object attributes using the TreeTable data type.

Fixed

  • Fixed an issue that prevented the creation or updating of a model object when an attribute was temporarily locked during writing.

  • Fixed an issue with the get_object_list method in RSECTION.

2.11.10 - 08/09/2025#

Action Required

  • Renamed model object attributes of type TreeTable to better indicate the possibility of using related helper functions, such as get_tree_value(), for retrieving and setting values:

    # Before
SteelDesignUlsConfiguration.SettingsEc3Table
# After
SteelDesignUlsConfiguration.SettingsEc3TreeTable
Added

  • Added support for working with all data within design add-on configurations, like SettingsEc3TreeTable in SteelDesignUlsConfiguration.

  • Implemented an enumeration list for model object attributes, such as rebar_diameter_auto_diameters in SurfaceReinforcement, which allows retrieving and setting values from the list.

Fixed

  • Fixed an issue with retrieving surface result tables for mesh nodes using _MESH_NODES_TABLE enums in the get_result_table() function.

2.11.9 - 01/09/2025#

Action Required

  • The following method renaming has been implemented for improved clarity and consistency:

    # Before
import_model_from(), export_model_to()
# After
import_from(), export_to()
Added

  • Enhanced the import_from() method to support importing RSECTION cross-section data from a file, utilizing RsectionImportAttributes.

  • Introduced get_mesh_settings() and set_mesh_settings() methods for configuration of mesh attributes.

  • Added delete_mesh() and generate_mesh() methods to create and manage meshes based on updated settings.

  • Introduced get_mesh_statistics() to retrieve key mesh statistics, such as the number of mesh elements.

2.11.8 - 25/08/2025#

Added

  • Enhanced the C# client to support increased message size for retrieving results, allowing larger responses without triggering resource exhaustion errors.

2.11.7 - 18/08/2025#

Added

  • Enhanced get_result_table() to allow retrieval of aluminium and steel design results on surfaces.

2.11.6 - 11/08/2025#

Added

  • Enhanced get_result_table() to allow retrieval of surface results specifically for grid points or mesh nodes.

2.11.5 - 04/08/2025#

Added

  • Enhanced get_results() to retrieve member local and global deformations and strains for supported types of analyses.

  • Enhanced get_result_table() to retrieve design add-on result tables, including the design_check_details_id column for accessing specific check details.

2.11.4 - 28/07/2025#

Added

  • Added support for communication with the RSECTION application server.

  • Introduced the method select_objects() to programmatically select objects in the scene.

  • Enhanced get_object_list() by adding the parameter only_selected to return only currently selected objects from the object list.

  • Enhanced get_results() by adding the parameter model_id to retrieve results from a specific model.

Fixed

  • Added back missing settings in get_results() to specify the coordinate system used when retrieving results.

  • Fixed an issue in get_object_list() that prevented proper retrieval of multiple objects from a specified model in C#.

Docs

  • Extended documentation to include API references and examples for the RSECTION application.

2.11.3 - 21/07/2025#

Added

  • Introduced the new method has_results() to check in advance whether results are available for specific loading.

  • Enhanced get_result_table() to support access to ERRORS_AND_WARNINGS_TABLE.

  • Enhanced get_result_table() by extending the tag column in the output to include additional information for easier filtering and better table formatting.

2.11.2 - 14/07/2025#

Added

  • Introduced the new method calculate_specific() to perform calculations for specific loading, such as selected load cases, combinations , …

  • Enhanced get_results() by adding the parameters nodal_support_coordinate_system and member_axes_system to specify the coordinate system used when retrieving results for nodal supports or members.

2.11.1 - 07/07/2025#

Added

  • Enhanced get_result_table() to retrieve all type of results from Static analysis.

  • Support for tree-structured table attributes in model objects (e.g., Block.parameters, MovingLoad.lane_definitions).

  • Helper functions get_tree_item(), get_tree_value(), and set_tree_value() for effortless navigation and editing of tree-structured tables.

2.10.13 - 30/06/2025#

Added

  • Support using dlubal.api in the demo version of the application, with the same restrictions as the desktop version.

2.10.12 - 23/06/2025#

Added

  • Enhanced get_results() to retrieve results about ..._NODES_SUPPORT_FORCES for all types of analyses.

  • Enhanced export_model_to() to support IFC file format using IfcExportAttributes.

  • Made get_result_table() available for C# client as well.

Fixed

  • Resolved an issue with get_object_list() to properly retrieve all objects with multiple types at once.

Docs

  • Added an example of user-defined extension of get_internal_forces() to obtain internal forces on member at a specific location using linear interpolation.

2.10.11 - 16/06/2025#

Added

  • Enhanced get_results() and get_result_table() to support additional global coordination systems (previously only global/local Z-downward was supported).

Fixed

  • Resolved issues with the ObjectType and ObjectId attributes across all related API methods for RSTAB.

2.10.10 - 09/06/2025#

Added

  • Added support for communication with the RSTAB application server.

  • Released a dedicated C# client for the Dlubal API, available via NuGet.

  • Enhanced the get_results() method to retrieve results from Design Add-ons.

  • Extended the get_results() method to provide access to Design Check Details.

Docs

  • Extended documentation to include API references and examples for the RSTAB application.

2.10.9 - 02/06/2025#

Added

  • Introduced new method export_model_to() with initial support for the PythonGrpcExportAttributes.

Docs

  • Updated Installation section to guide installation of the C# client NuGet package.

  • Improved Quick Start section to provide clearer instructions on getting started with the Dlubal API.

2.10.8 - 26/05/2025#

Fixed

  • Resolved an issue in save_model() where saving a model under a different name did not update the model GUID, causing parent and child models to share the same GUID.

Docs

  • Updated Installation section to describe enhanced configuration related to In-app Console.

2.10.7 - 19/05/2025#

Action Required

  • Renamed attributes and enums related to member results in get_results():

    Before: rfem.results.STATIC_ANALYSIS_MEMBER_INTERNAL_FORCES

    After: rfem.results.STATIC_ANALYSIS_MEMBERS_INTERNAL_FORCES

Added

  • New method import_model_from() introduced with support for the first data type input IfcImportAttributes.

  • Extended get_results() method to include additional ResultsType for Surfaces and Solids and introduce upfront filtering through the filters attribute.

2.10.6 - 12/05/2025#

Action Required

  • Use of ObjectId instead of int for loading-related attributes:

    Before: case_object_item=load_combi.no

    After: case_object_item=rfem.ObjectId(no=load_combi.no, object_type=rfem.OBJECT_TYPE_LOAD_COMBINATION))

  • Renamed attributes and enums in get_results():

    Before: results_id=rfem.results.RESULTS_ID_STATIC_ANALYSIS_MEMBER_INTERNAL_FORCES

    After: results_type=rfem.results.STATIC_ANALYSIS_MEMBER_INTERNAL_FORCES

Added

  • New method get_result_table() to get specific result table as Pandas DataFrame.

  • New method convert_objects() to convert objects from source model like IFC.

2.10.5 - 05/05/2025#

Docs

  • Extended the API documentation in preparation for the upcoming release of the C# client.

2.10.4 - 28/04/2025#

Added

  • Possibility to define the coordinate_system attribute as custom using its number or by selecting from predefined via an enum like COORDINATE_SYSTEM_TYPE_LOCAL.

2.10.3 - 22/04/2025#

Added

  • New methods get_base_data() and set_base_data() to deal with model Base Data.

2.10.2 - 14/04/2025#

(No changes)

2.10.1 - 07/04/2025#

Action Required

  • No longer returning ObjectId or ObjectIdList from the create_object() or create_object_list() functions.

Added

  • Extended method get_object_list() to easily fetch all objects or all objects of a specific type.

  • New method generate_combinations().

2.9.12 - 31/03/2025#

Fixed

  • Enhanced exception handling for authentication and authorization processes, ensuring better clarity.

2.9.11 - 24/03/2025#

Action Required

  • Enum values now follow a more structured naming convention under the respective object namespace.

    Before: rfem.loads.NodalLoadLoadType.NODAL_LOAD_LOAD_TYPE_COMPONENTS

    After: rfem.loads.NodalLoad.LOAD_TYPE_COMPONENTS

  • Data object constructors are now accessed via the object type namespace for better clarity.

    Before: rfem.loading.LoadCombinationItemsTable()

    After: rfem.loading.LoadCombination.ItemsTable()

  • Replaced string-based attributes with enums where applicable.

    Before: action_category="ACTION_CATEGORY_PERMANENT_G"

    After: action_category=rfem.loading.LoadCase.ACTION_CATEGORY_PERMANENT_G

2.9.10 - 17/03/2025#

Docs

  • Introduced a changelog section in the documentation.

2.9.9 - 10/03/2025#

Fixed

  • Enhanced output message from plausibility_check().

  • Missing output from get_object_id_list() for some ‘object_type’ input.

  • Presentation of ‘<NA>’ values when printing get_results() output.

2.9.8 - 03/03/2025#

Added

  • New method get_object_id_list().

  • New method get_results().

  • Automated check of API client version compatibility with Dlubal application version.

2.9.7 - 24/02/2025#

Action Required

  • Renaming ‘id’ attribute to ‘guid’ in ModelId object.

Added

  • New method get_model_main_parameters().

2.9.6 - 17/02/2025#

(No changes)

2.9.5 - 11/02/2025#

Fixed

  • Incorrect output message from create_object_list()

2.9.4 - 03/02/2025#

(Initial release)