### Install Prerequisites

Source: https://github.com/dlubal-software/rfem_python_client/blob/main/Examples/LinkUSGS/README.md

Installs necessary Python packages for the web application. Run this command in your terminal.

```bash
pip install streamlit plotly.express pillow --user
```

--------------------------------

### Example Material Section

Source: https://github.com/dlubal-software/rfem_python_client/blob/main/Examples/GPT_Tank/templates/material.txt

Provides a concrete example of how to instantiate the Material section with a specific number and name.

```python
# ---- Material Sec ----
Material(1, "S235")
```

--------------------------------

### Install xlwings Add-in

Source: https://github.com/dlubal-software/rfem_python_client/blob/main/Examples/SteelDesign/README.md

Install the xlwings add-in using the command line client. The add-in is password protected with 'xlwings' by default.

```bash
xlwings addin install
```

--------------------------------

### Example Geometry Definition in RFEM Python Client

Source: https://github.com/dlubal-software/rfem_python_client/blob/main/Examples/GPT_Tank/templates/geometry.txt

This example demonstrates the creation of a node, a circular line, and a hinged line support. It serves as a basic illustration of how to define geometric elements and supports.

```python
# ---- Geometry Sec ----
Node(1, 1, 0,0)

Line.Circle(1, [0,0,0], 3, [0,0,1])

LineSupport(1, '1', LineSupportType.HINGED)
```

--------------------------------

### Install numpy Package

Source: https://github.com/dlubal-software/rfem_python_client/blob/main/Examples/SteelDesign/README.md

Install the numpy library using pip. Ensure pip is updated to version 19.3 or higher for PyPI compatibility.

```bash
pip install numpy
```

--------------------------------

### Get Opening

Source: https://github.com/dlubal-software/rfem_python_client/wiki/WS-Model-Methods-and-Types

Retrieves a specific opening from the model.

```APIDOC
## GET /opening

### Description
Retrieves a specific opening from the model.

### Method
GET

### Endpoint
/opening

### Parameters
#### Query Parameters
- **id** (int) - Required - The ID of the opening to retrieve.
```

--------------------------------

### Get Action

Source: https://github.com/dlubal-software/rfem_python_client/wiki/WS-Model-Methods-and-Types

Retrieves an action by its number.

```python
get_action(xs:int no, )
```

--------------------------------

### Get Line Release

Source: https://github.com/dlubal-software/rfem_python_client/wiki/WS-Model-Methods-and-Types

Retrieves line release settings by its number.

```python
get_line_release(xs:int no, )
```

--------------------------------

### Get Addon Statuses

Source: https://github.com/dlubal-software/rfem_python_client/wiki/WS-Model-Methods-and-Types

Retrieves the current status of all available addons.

```python
get_addon_statuses()
```

--------------------------------

### Run RFEM 6 Server with Parameters

Source: https://github.com/dlubal-software/rfem_python_client/wiki/RFEM6Server-RFEM-without-GUI

Execute RFEM 6 Server from the command line, specifying login credentials, license information, and server port settings. Ensure all parameters are separated by spaces.

```bash
.\RFEM6Server.exe --email=jane.doe@gmail.com --password=125 --license=000005-25 --start-soap-server=8081 --soap-number-of-model-server-ports=10
```

--------------------------------

### Install xlwings Package

Source: https://github.com/dlubal-software/rfem_python_client/blob/main/Examples/SteelDesign/README.md

Install the xlwings library using either pip or conda. xlwings is pre-installed with Anaconda and WinPython distributions.

```bash
pip install xlwings
```

```bash
conda install xlwings
```

--------------------------------

### Initialize Client and Query Model List

Source: https://github.com/dlubal-software/rfem_python_client/wiki/How-to-query-the-model

Initializes the SUDS client, prints all application functions and types, retrieves the model list, and creates a client for the active model.

```python
from suds.client import Client
import sys

client = Client('http://localhost:8081/wsdl')
# printout all application functions and types
print(client)
modelLst = client.service.get_model_list()
new = client.service.get_active_model()+'wsdl'
model = Client(new)
# printout all model functions and types
print(model)
# printout all available variables of object node
print(client.factory.create('ns0:node'))
```

--------------------------------

### Install pandas Package

Source: https://github.com/dlubal-software/rfem_python_client/blob/main/Examples/SteelDesign/README.md

Install the pandas library using pip. This package is officially supported on Python versions 3.8, 3.9, 3.10, and 3.11.

```bash
pip install pandas
```

--------------------------------

### List RFEM Client Methods

Source: https://github.com/dlubal-software/rfem_python_client/wiki/WS-Application-Methods-and-Types

Execute this command to print the client object and view all available methods for interacting with the RFEM application.

```python
print(client)
```

--------------------------------

### Calculate All

Source: https://github.com/dlubal-software/rfem_python_client/wiki/WS-Model-Methods-and-Types

Initiates a full calculation of the model. Optionally skips warnings.

```python
calculate_all(xs:boolean skip_warnings, )
```

--------------------------------

### new_project

Source: https://github.com/dlubal-software/rfem_python_client/wiki/WS-Application-Methods-and-Types

Creates a new project with the provided project information.

```APIDOC
## new_project

### Description
Creates a new project with the provided project information.

### Method
`client.service.new_project(ns0:project_info project_info)`

### Parameters
#### Path Parameters
- **project_info** (project_info) - Required - Information about the new project.
```

--------------------------------

### Get Intersection

Source: https://github.com/dlubal-software/rfem_python_client/wiki/WS-Model-Methods-and-Types

Retrieves an intersection by its number.

```python
get_intersection(xs:int no, )
```

--------------------------------

### Set Nodal Support with Params

Source: https://github.com/dlubal-software/rfem_python_client/wiki/How-to-set-'params'

Demonstrates how to instantiate a NodalSupport object and pass a dictionary to the 'params' argument to set specific attributes, such as 'diagram_along_x_end'.

```python
NodalSupport(..., params = {'diagram_along_x_end':"DIAGRAM_ENDING_TYPE_CONTINUOUS"})
```

--------------------------------

### Get Accelerogram

Source: https://github.com/dlubal-software/rfem_python_client/wiki/WS-Model-Methods-and-Types

Retrieves an accelerogram by its number.

```python
get_accelerogram(xs:int no, )
```

--------------------------------

### Initialize Report Functionality

Source: https://github.com/dlubal-software/rfem_python_client/blob/main/UnitTests/report.html

Sets up the initial state of the report, including resetting sort headers, adding collapse functionality, showing filters, and attaching sort event listeners.

```javascript
function init () { // eslint-disable-line no-unused-vars resetSortHeaders(); addCollapse(); showFilters(); sortColumn(find('.initial-sort')); findAll('.sortable').forEach(function(elem) { elem.addEventListener('click', function() { sortColumn(elem); }, false); }); }
```

--------------------------------

### Run USGS Link Web App

Source: https://github.com/dlubal-software/rfem_python_client/blob/main/Examples/LinkUSGS/README.md

Starts the Streamlit web application. This command should be executed from your project's root directory.

```bash
python -m streamlit run .\Examples\LinkUSGS\UsgsRFEMLink.py
```

--------------------------------

### Get Note

Source: https://github.com/dlubal-software/rfem_python_client/wiki/WS-Model-Methods-and-Types

Retrieves a specific note from the model.

```APIDOC
## GET /note

### Description
Retrieves a specific note from the model.

### Method
GET

### Endpoint
/note

### Parameters
#### Query Parameters
- **id** (int) - Required - The ID of the note to retrieve.
```

--------------------------------

### RFEM 6 Server Help Command

Source: https://github.com/dlubal-software/rfem_python_client/wiki/RFEM6Server-RFEM-without-GUI

Display available command-line arguments for RFEM 6 Server to understand its configuration options. Use this command when looking for specific arguments.

```bash
RFEM6Server.exe --DEV-help
```

--------------------------------

### Define and Execute Solver Section

Source: https://github.com/dlubal-software/rfem_python_client/blob/main/Examples/GPT_Tank/templates/solver.txt

Use this syntax to define the solver section and initiate calculations. Ensure modifications are finished before calling Calculate_all().

```python
# ---- Solver Sec ----
Model.clientModel.service.finish_modification()

Calculate_all()
```

--------------------------------

### Get Node

Source: https://github.com/dlubal-software/rfem_python_client/wiki/WS-Model-Methods-and-Types

Retrieves a specific node from the model.

```APIDOC
## GET /node

### Description
Retrieves a specific node from the model.

### Method
GET

### Endpoint
/node

### Parameters
#### Query Parameters
- **id** (int) - Required - The ID of the node to retrieve.
```

--------------------------------

### import_from

Source: https://github.com/dlubal-software/rfem_python_client/wiki/WS-Application-Methods-and-Types

Imports data from a specified file path.

```APIDOC
## import_from

### Description
Imports data from a specified file path.

### Method
`client.service.import_from(xs:string file_path)`

### Parameters
#### Path Parameters
- **file_path** (string) - Required - The path to the file to import from.
```

--------------------------------

### Get Model Type

Source: https://github.com/dlubal-software/rfem_python_client/wiki/WS-Model-Methods-and-Types

Retrieves the type of the model.

```APIDOC
## GET /model_type

### Description
Retrieves the type of the model.

### Method
GET

### Endpoint
/model_type
```

--------------------------------

### Get Model Parameters

Source: https://github.com/dlubal-software/rfem_python_client/wiki/WS-Model-Methods-and-Types

Retrieves all parameters of the model.

```APIDOC
## GET /model_parameters

### Description
Retrieves all parameters of the model.

### Method
GET

### Endpoint
/model_parameters
```

--------------------------------

### Set Pushover Analysis Settings

Source: https://github.com/dlubal-software/rfem_python_client/wiki/WS-Model-Methods-and-Types

Configures settings for pushover analysis. This allows users to define parameters for nonlinear static analysis.

```APIDOC
## set_pushover_analysis_settings

### Description
Configures settings for pushover analysis.

### Method
Not specified (assumed to be a client-side method call)

### Endpoint
Not applicable (Python client method)

### Parameters
* **pushover_settings_data** (object) - Required - Data defining the pushover analysis settings.

### Request Example
```json
{
  "pushover_settings_data": { ... }
}
```

### Response
#### Success Response (200)
* **success** (boolean) - Indicates if the operation was successful.

#### Response Example
```json
{
  "success": true
}
```
```

--------------------------------

### Get Member

Source: https://github.com/dlubal-software/rfem_python_client/wiki/WS-Model-Methods-and-Types

Retrieves a specific member from the model.

```APIDOC
## GET /member

### Description
Retrieves a specific member from the model.

### Method
GET

### Endpoint
/member

### Parameters
#### Query Parameters
- **id** (int) - Required - The ID of the member to retrieve.
```

--------------------------------

### Get Material

Source: https://github.com/dlubal-software/rfem_python_client/wiki/WS-Model-Methods-and-Types

Retrieves a specific material from the model.

```APIDOC
## GET /material

### Description
Retrieves a specific material from the model.

### Method
GET

### Endpoint
/material

### Parameters
#### Query Parameters
- **id** (int) - Required - The ID of the material to retrieve.
```

--------------------------------

### Show Filters

Source: https://github.com/dlubal-software/rfem_python_client/blob/main/UnitTests/report.html

Initializes and displays filter options based on URL query parameters. Filters are applied by calling filterTable.

```javascript
function showFilters() { let visibleString = getQueryParameter('visible') || 'all'; visibleString = visibleString.toLowerCase(); const checkedItems = visibleString.split(','); const filterItems = document.getElementsByClassName('filter'); for (let i = 0; i < filterItems.length; i++) { filterItems[i].hidden = false; if (visibleString != 'all') { filterItems[i].checked = checkedItems.includes(filterItems[i].getAttribute('data-test-result')); filterTable(filterItems[i]); } } }
```

--------------------------------

### get_main_objects_to_activate

Source: https://github.com/dlubal-software/rfem_python_client/wiki/WS-Model-Methods-and-Types

Retrieves a list of main objects that can be activated.

```APIDOC
## get_main_objects_to_activate

### Description
Retrieves a list of main objects that can be activated.

### Method
get_main_objects_to_activate()
```

--------------------------------

### Get Line

Source: https://github.com/dlubal-software/rfem_python_client/wiki/WS-Model-Methods-and-Types

Retrieves a line object by its number.

```python
get_line(xs:int no, )
```

--------------------------------

### Get Dimension

Source: https://github.com/dlubal-software/rfem_python_client/wiki/WS-Model-Methods-and-Types

Retrieves dimension information by its number.

```python
get_dimension(xs:int no, )
```

--------------------------------

### Get Timber Design Design Ratios by Loading for Surfaces

Source: https://github.com/dlubal-software/rfem_python_client/wiki/WS-Model-Methods-and-Types

Retrieves timber design ratios for surfaces based on loading conditions.

```APIDOC
## GET /get_results_for_timber_design_design_ratios_surfaces_by_loading

### Description
Retrieves timber design ratios for surfaces, filtered by loading conditions.

### Method
GET

### Endpoint
/get_results_for_timber_design_design_ratios_surfaces_by_loading

### Parameters
#### Query Parameters
- **loading** (string) - Required - The identifier for the loading condition.
```

--------------------------------

### Begin Modification

Source: https://github.com/dlubal-software/rfem_python_client/wiki/WS-Model-Methods-and-Types

Starts a new modification block with a given name. All subsequent changes will be part of this modification until finish_modification() is called.

```python
begin_modification(xs:string modification_name, )
```

--------------------------------

### Get Borehole

Source: https://github.com/dlubal-software/rfem_python_client/wiki/WS-Model-Methods-and-Types

Retrieves borehole data by its number.

```python
get_borehole(xs:int no, )
```

--------------------------------

### Get Optimized Values

Source: https://github.com/dlubal-software/rfem_python_client/wiki/WS-Model-Methods-and-Types

Retrieves the optimized values for the model.

```APIDOC
## GET /optimized_values

### Description
Retrieves the optimized values for the model.

### Method
GET

### Endpoint
/optimized_values
```

--------------------------------

### get_opening

Source: https://github.com/dlubal-software/rfem_python_client/wiki/WS-Model-Methods-and-Types

Retrieves information about a specific opening.

```APIDOC
## get_opening

### Description
Retrieves information about a specific opening.

### Method
get_opening(xs: int no)

### Parameters
#### Path Parameters
- **no** (int) - Required - The number of the opening.
```

--------------------------------

### Initialize RFEM Model

Source: https://github.com/dlubal-software/rfem_python_client/blob/main/Examples/GPT_Tank/ChatGPT_Tank_E.ipynb

Initializes the RFEM model and begins a modification session. Ensure RFEM is running and accessible.

```python
import os
import sys

from RFEM.enums import LineSupportType, SurfaceGeometry, SurfaceLoadDirection, SurfaceLoadDistribution, ActionCategoryType
from RFEM.initModel import Calculate_all, Model
from RFEM.BasicObjects.node import Node
from RFEM.BasicObjects.line import Line
from RFEM.BasicObjects.material import Material
from RFEM.BasicObjects.thickness import Thickness
from RFEM.BasicObjects.surface import Surface
from RFEM.TypesForLines.lineSupport import LineSupport
from RFEM.TypesForNodes.nodalSupport import NodalSupport
from RFEM.Results.resultTables import GetMaxValue, ResultTables
from RFEM.Loads.surfaceLoad import SurfaceLoad
from RFEM.LoadCasesAndCombinations.loadCase import LoadCase
from RFEM.ImportExport.exports import ExportTo

Model(True, 'ChatGPT_Tank.rf6')
Model.clientModel.service.begin_modification()
```

--------------------------------

### Get Optimization Settings

Source: https://github.com/dlubal-software/rfem_python_client/wiki/WS-Model-Methods-and-Types

Retrieves the optimization settings for the model.

```APIDOC
## GET /optimization_settings

### Description
Retrieves the optimization settings for the model.

### Method
GET

### Endpoint
/optimization_settings
```

--------------------------------

### Default Model Initialization

Source: https://github.com/dlubal-software/rfem_python_client/wiki/How-to-edit-multiple-models-in-one-script

Initialize a single model and perform operations on it. This is the simplest approach for basic scripting needs.

```python
Model(True, "TestModel") <-- create new model
Material(1,'S235') <-- assign material to TestModel
Material(2,'S235') <-- assign material to TestModel
```

--------------------------------

### Get My Section Lists

Source: https://github.com/dlubal-software/rfem_python_client/wiki/WS-Model-Methods-and-Types

Retrieves user-defined section lists.

```APIDOC
## GET /my_section_lists

### Description
Retrieves user-defined section lists.

### Method
GET

### Endpoint
/my_section_lists
```

--------------------------------

### Get Model Info

Source: https://github.com/dlubal-software/rfem_python_client/wiki/WS-Model-Methods-and-Types

Retrieves general information about the model.

```APIDOC
## GET /model_info

### Description
Retrieves general information about the model.

### Method
GET

### Endpoint
/model_info
```

--------------------------------

### Get Model Settings and Options

Source: https://github.com/dlubal-software/rfem_python_client/wiki/WS-Model-Methods-and-Types

Retrieves the general settings and options for the model.

```APIDOC
## GET /model_settings_and_options

### Description
Retrieves the general settings and options for the model.

### Method
GET

### Endpoint
/model_settings_and_options
```

--------------------------------

### Get Mesh Settings

Source: https://github.com/dlubal-software/rfem_python_client/wiki/WS-Model-Methods-and-Types

Retrieves the mesh settings for the model.

```APIDOC
## GET /mesh_settings

### Description
Retrieves the mesh settings for the model.

### Method
GET

### Endpoint
/mesh_settings
```

--------------------------------

### get_pushover_analysis_settings

Source: https://github.com/dlubal-software/rfem_python_client/wiki/WS-Model-Methods-and-Types

Retrieves the pushover analysis settings.

```APIDOC
## get_pushover_analysis_settings

### Description
Retrieves the pushover analysis settings.

### Method
get_pushover_analysis_settings(xs: int no)

### Parameters
#### Path Parameters
- **no** (int) - Required - The number of the pushover analysis settings.
```

--------------------------------

### Get Line Set

Source: https://github.com/dlubal-software/rfem_python_client/wiki/WS-Model-Methods-and-Types

Retrieves a line set by its number.

```python
get_line_set(xs:int no, )
```

--------------------------------

### Get Design Overview

Source: https://github.com/dlubal-software/rfem_python_client/blob/main/Examples/GPT_Tank/templates/results.txt

Retrieves the design overview for a given model. Ensure the Model object is properly initialized.

```python
GetDesignOverview(model = Model)
```

--------------------------------

### Get Line Hinge

Source: https://github.com/dlubal-software/rfem_python_client/wiki/WS-Model-Methods-and-Types

Retrieves a line hinge by its number.

```python
get_line_hinge(xs:int no, )
```

--------------------------------

### Define Thicknesses and Surfaces

Source: https://github.com/dlubal-software/rfem_python_client/blob/main/Examples/GPT_Tank/ChatGPT_Tank_D.ipynb

Defines the thicknesses for the top cover and cylindrical shell, and then creates the corresponding surfaces.

```python
# Define the thickness for the top cover
Thickness(1, '10 mm', 1, 0.010)

# Define the thickness for the cylindrical shell
Thickness(2, '4 mm', 1, 0.004)

# Define the top cover as a flat plane surface
Surface.Standard(1, SurfaceGeometry.GEOMETRY_PLANE, None, '2', 1)

# Define the cylindrical shell as a surface of revolution
Surface.Standard(2, SurfaceGeometry.GEOMETRY_ROTATED, [360, [0, 0, 0], [0, 0, 1], 3], '3', 2)
```

--------------------------------

### Get Imperfection Case

Source: https://github.com/dlubal-software/rfem_python_client/wiki/WS-Model-Methods-and-Types

Retrieves an imperfection case by its number.

```python
get_imperfection_case(xs:int no, )
```

--------------------------------

### Get Timber Design Design Ratios by Thickness

Source: https://github.com/dlubal-software/rfem_python_client/wiki/WS-Model-Methods-and-Types

Retrieves timber design ratios for surfaces based on thickness.

```APIDOC
## GET /get_results_for_timber_design_design_ratios_surfaces_by_thickness

### Description
Retrieves timber design ratios for surfaces, filtered by thickness.

### Method
GET

### Endpoint
/get_results_for_timber_design_design_ratios_surfaces_by_thickness

### Parameters
#### Query Parameters
- **thickness** (string) - Required - The identifier for the thickness.
```

--------------------------------

### Get Global Parameter

Source: https://github.com/dlubal-software/rfem_python_client/wiki/WS-Model-Methods-and-Types

Retrieves a global parameter by its number.

```python
get_global_parameter(xs:int no, )
```

--------------------------------

### Get Timber Design Design Ratios by Material for Surfaces

Source: https://github.com/dlubal-software/rfem_python_client/wiki/WS-Model-Methods-and-Types

Retrieves timber design ratios for surfaces based on material.

```APIDOC
## GET /get_results_for_timber_design_design_ratios_surfaces_by_material

### Description
Retrieves timber design ratios for surfaces, filtered by material.

### Method
GET

### Endpoint
/get_results_for_timber_design_design_ratios_surfaces_by_material

### Parameters
#### Query Parameters
- **material** (string) - Required - The identifier for the material.
```

--------------------------------

### Get Design Situation

Source: https://github.com/dlubal-software/rfem_python_client/wiki/WS-Model-Methods-and-Types

Retrieves a design situation by its number.

```python
get_design_situation(xs:int no, )
```

--------------------------------

### Retrieve Surface Equivalent Stresses (Mises)

Source: https://github.com/dlubal-software/rfem_python_client/blob/main/Examples/GPT_Tank/templates/results.txt

Initializes the retrieval of surface equivalent stresses using the Mises criterion. This is a setup step before processing.

```python
ResultTables.SurfacesEquivalentStressesMises()
```

--------------------------------

### get_results_for_pushover_analysis_building_stories_story_actions

Source: https://github.com/dlubal-software/rfem_python_client/wiki/WS-Model-Methods-and-Types

Retrieves story actions for building stories in pushover analysis.

```APIDOC
## get_results_for_pushover_analysis_building_stories_story_actions

### Description
Retrieves the story actions (forces and moments) for each story of the building during pushover analysis.

### Parameters
- **loading_type** (ns0:case_object_types) - Required - The type of loading case.
- **loading_no** (xs:int) - Required - The number of the loading case.
- **no** (xs:int) - Required - The number of the pushover analysis.
```

--------------------------------

### Get Calculation Diagram

Source: https://github.com/dlubal-software/rfem_python_client/wiki/WS-Model-Methods-and-Types

Retrieves a calculation diagram by its number.

```python
get_calculation_diagram(xs:int no, )
```

--------------------------------

### Get Action Combination

Source: https://github.com/dlubal-software/rfem_python_client/wiki/WS-Model-Methods-and-Types

Retrieves an action combination by its number.

```python
get_action_combination(xs:int no, )
```

--------------------------------

### Import RFEM Python Client Modules

Source: https://github.com/dlubal-software/rfem_python_client/wiki/How-to-start

Import necessary modules for interacting with RFEM. Ensure these are at the beginning of your script.

```python
from RFEM.initModel import Model
from RFEM.BasicObjects.material import Material
from RFEM.BasicObjects.line import Line
```

--------------------------------

### Get Result Combination

Source: https://github.com/dlubal-software/rfem_python_client/wiki/WS-Model-Methods-and-Types

Retrieves a specific result combination from the model.

```APIDOC
## GET /result_combination

### Description
Retrieves a specific result combination from the model.

### Method
GET

### Endpoint
/result_combination

### Parameters
#### Query Parameters
- **id** (int) - Required - The ID of the result combination to retrieve.
```

--------------------------------

### Get Timber Design Design Ratios by Design Situation for Surfaces

Source: https://github.com/dlubal-software/rfem_python_client/wiki/WS-Model-Methods-and-Types

Retrieves timber design ratios for surfaces based on design situation.

```APIDOC
## GET /get_results_for_timber_design_design_ratios_surfaces_by_design_situation

### Description
Retrieves timber design ratios for surfaces, filtered by design situation.

### Method
GET

### Endpoint
/get_results_for_timber_design_design_ratios_surfaces_by_design_situation

### Parameters
#### Query Parameters
- **design_situation** (string) - Required - The identifier for the design situation.
```

--------------------------------

### Get Response Spectrum

Source: https://github.com/dlubal-software/rfem_python_client/wiki/WS-Model-Methods-and-Types

Retrieves the response spectrum settings for the model.

```APIDOC
## GET /response_spectrum

### Description
Retrieves the response spectrum settings for the model.

### Method
GET

### Endpoint
/response_spectrum
```

--------------------------------

### Get Opening Load

Source: https://github.com/dlubal-software/rfem_python_client/wiki/WS-Model-Methods-and-Types

Retrieves the loads applied to a specific opening.

```APIDOC
## GET /opening_load

### Description
Retrieves the loads applied to a specific opening.

### Method
GET

### Endpoint
/opening_load

### Parameters
#### Query Parameters
- **opening_id** (int) - Required - The ID of the opening.
```

--------------------------------

### Get Object Snap

Source: https://github.com/dlubal-software/rfem_python_client/wiki/WS-Model-Methods-and-Types

Retrieves the object snap settings for the model.

```APIDOC
## GET /object_snap

### Description
Retrieves the object snap settings for the model.

### Method
GET

### Endpoint
/object_snap
```

--------------------------------

### Create a New RFEM Model

Source: https://github.com/dlubal-software/rfem_python_client/wiki/How-to-start

Initialize a new RFEM model. Pass 'True' to create a new model and provide a name for it.

```python
Model(True, 'MyModel')
```

--------------------------------

### Get Nodal Load

Source: https://github.com/dlubal-software/rfem_python_client/wiki/WS-Model-Methods-and-Types

Retrieves a specific nodal load from the model.

```APIDOC
## GET /nodal_load

### Description
Retrieves a specific nodal load from the model.

### Method
GET

### Endpoint
/nodal_load

### Parameters
#### Query Parameters
- **id** (int) - Required - The ID of the nodal load to retrieve.
```

--------------------------------

### Get Timber Design Design Ratios by Construction Stage for Surfaces

Source: https://github.com/dlubal-software/rfem_python_client/wiki/WS-Model-Methods-and-Types

Retrieves timber design ratios for surfaces based on construction stage.

```APIDOC
## GET /get_results_for_timber_design_design_ratios_surfaces_by_construction_stage

### Description
Retrieves timber design ratios for surfaces, filtered by construction stage.

### Method
GET

### Endpoint
/get_results_for_timber_design_design_ratios_surfaces_by_construction_stage

### Parameters
#### Query Parameters
- **construction_stage** (string) - Required - The identifier for the construction stage.
```

--------------------------------

### get_results_for_pushover_analysis_convergence_diagrams

Source: https://github.com/dlubal-software/rfem_python_client/wiki/WS-Model-Methods-and-Types

Retrieves convergence diagrams for pushover analysis.

```APIDOC
## get_results_for_pushover_analysis_convergence_diagrams

### Description
Retrieves the convergence diagrams related to the pushover analysis.

### Parameters
- **loading_type** (ns0:case_object_types) - Required - The type of loading case.
- **loading_no** (xs:int) - Required - The number of the loading case.
- **no** (xs:int) - Required - The number of the pushover analysis.
```

--------------------------------

### Get Model Parameters Location

Source: https://github.com/dlubal-software/rfem_python_client/wiki/WS-Model-Methods-and-Types

Retrieves the location-specific parameters of the model.

```APIDOC
## GET /model_parameters_location

### Description
Retrieves the location-specific parameters of the model.

### Method
GET

### Endpoint
/model_parameters_location
```

--------------------------------

### Get Model Main Parameters

Source: https://github.com/dlubal-software/rfem_python_client/wiki/WS-Model-Methods-and-Types

Retrieves the main parameters of the model.

```APIDOC
## GET /model_main_parameters

### Description
Retrieves the main parameters of the model.

### Method
GET

### Endpoint
/model_main_parameters
```

--------------------------------

### Create Section List

Source: https://github.com/dlubal-software/rfem_python_client/wiki/WS-Model-Methods-and-Types

Creates a new section list with the specified name.

```python
create_my_section_list(xs:string list_name, )
```

--------------------------------

### Get Model History

Source: https://github.com/dlubal-software/rfem_python_client/wiki/WS-Model-Methods-and-Types

Retrieves the history of changes made to the model.

```APIDOC
## GET /model_history

### Description
Retrieves the history of changes made to the model.

### Method
GET

### Endpoint
/model_history
```

--------------------------------

### Populate and Set Nested Diagram Table via Params

Source: https://github.com/dlubal-software/rfem_python_client/wiki/How-to-set-'params'

This snippet shows how to programmatically create and populate a nested structure for 'diagram_along_x_table' using the RFEM client's factory, then pass it to the NodalSupport object via the 'params' argument.

```python
diagram_along_x = model.clientModel.factory.create('ns0:response_spectrum.user_defined_response_spectrum')
for i,j in enumerate(nodal_support_diagrams):
    ns = model.clientModel.factory.create('ns0:nodal_support_diagram_along_x_table_row')
    ns.no = i+1
    ns.row.displacement= user_defined_spectrum[i][0]
    rsp.row.force= user_defined_spectrum[i][1]
    ns.row.force= user_defined_spectrum[i][2]

    diagram_along_x.nodal_support_diagram_along_x_table.append(ns)

NodalSupport(..., params = {'diagram_along_x_end':"DIAGRAM_ENDING_TYPE_CONTINUOUS", 'diagram_along_x_table' : diagram_along_x})
```