Table of Contents

ideastatica-rcs-api

The Python package for the RCS Rest API 1.0

  • API version: 1.0
  • Package version: 25.1.5.1431

IDEA StatiCa RCS API, used for the automated design and calculation of reinforced concrete sections.

Requirements.

Python 3.7+

Installation

pip install

We reccomend using pip to install the package into your environment.

pip install ideastatica_rcs_api

Then import the package in your project:

import ideastatica_rcs_api

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Usage

RcsApiServiceAttacher manages creation of clients on the running service. We currently only support connecting to a service running on a localhost (eg. 'http://localhost:5000/').

To start the service, manually navigate to the "C:\Program Files\IDEA StatiCa\StatiCa 25.1" folder. Using CLI:

IdeaStatiCa.RcsRestApi.exe -port=5000

import ideastatica_rcs_api.rcs_api_service_attacher as rcs_api_service_attacher

# Connect to the running service.
with rcs_api_service_attacher.RcsApiServiceAttacher('http://localhost:5000').create_api_client() as api_client:
    api_client.project.open_project_from_file('myRcsProject.ideaRcs')

Getting Started

Please follow the installation procedure and then run the following:

Documentation for API Endpoints

The RcsApiClient wraps all API endpoing controllers into object based or action baseds API endpoints.

Methods marked with an ^ denote that they have an additional extension in the Client.

CalculationApi

Method Description
calculate Calculate RCS project
get_raw_results Get calculated results in XML format
get_results Get calculated results

ClientApi

Method Description
get_version Get the IdeaStatica version

CrossSectionApi

Method Description
add_reinforced_cross_section Add a new reinforced cross-section to the project from embedded geometry
get_reinforced_cross_section_data Get reinforced cross-section with full geometry (IOM format)
import_reinforced_cross_section Import reinforced cross-section from template
reinforced_cross_sections Get reinforced cross sections

DesignMemberApi

Method Description
members Get members

InternalForcesApi

Method Description
get_section_loading Get section loading
set_section_loading Set section loading

MaterialApi

Method Description
add_concrete_material Add a new material to the project. The material type is determined by the endpoint path.
add_prestress_material Add a new material to the project. The material type is determined by the endpoint path.
add_reinforcement_material Add a new material to the project. The material type is determined by the endpoint path.
get_all_materials Get materials from the project. Use specific path to filter by material type.
get_concrete_materials Get materials from the project. Use specific path to filter by material type.
get_prestress_materials Get materials from the project. Use specific path to filter by material type.
get_reinforcement_materials Get materials from the project. Use specific path to filter by material type.

ProjectApi

Method Description
close_project
download_project Download the actual rcs project from the service. It includes all changes which were made by previous API calls.
get_active_project
get_code_settings
get_code_settings_json
import_iom
import_iom_file
open
open_project Open Rcs project from rcsFile
update_code_settings

SectionApi

Method Description
sections Get sections
update_section Update a section in the RCS project

Documentation for Models

Notes

This Python package is automatically generated by the OpenAPI Generator project:

Edit this page