Quick Start#

Get started quickly with the Dlubal API using Python by following these simple steps.

  1. Install Dlubal Software (RFEM/RSTAB…)

  2. Set Up Your Python Environment

    • Install Python (version 3.10 or later) and Visual Studio Code.

    • Create a Virtual Environment.

    python -m venv my_env
    
    # Activate the environment (On Windows)
    source my_env/bin/activate
    
    • Install the Dlubal API Python Client

    pip install dlubal.api
    

    For additional setup options, refer to the Installation documentation.

  3. Generate and Secure Your API Key

    • Generate your API Key in Extranet > API & Cloud.

    • Store your API Keys in config.ini for better accessibility and security.

    [api_keys]
    key = your_actual_api_key_here
    
    • For Windows installations, the file should be placed in:

    C:\Program Files\Dlubal\RFEM 6.10\bin\Lib\site-packages\dlubal\api\config.ini
    

    For more details, see the Authentication documentation.

  4. Start Server and Connect with API

    • Start the Dlubal server software as described in (see Starting Server).

    • Connect using the API Python client as follows:

    from dlubal.api import rfem
    
    with rfem.Application(api_key_name='key') as rfem_app:
    
      print(rfem_app.get_application_info())
    
  5. Run Your First Example

    • Once you’re connected to the API, try running an example to verify everything is working correctly.

    • Visit the Examples documentation to start exploring API capabilities.

Webinar#