Skip to content

Latest commit

 

History

History
52 lines (30 loc) · 2.26 KB

rcs_api_getting_started.md

File metadata and controls

52 lines (30 loc) · 2.26 KB

RCS API

Welcome to the IDEA StatiCa RCS API (Application Programming Interface).

The RCS API can be used to interact with IDEA StatiCa RCS to create and optimize designs of reinforced cross-sections.

Important

As of version 23.1.3 a new RCS API is avaliable.

API Architecture

The RCS API is built on REST Open API architecture and runs over a http protocal. The current version of the API creates REST server which is hosted locally on a users computer. However, in the future we may also provide the possibility to run calculations on remote machines.

Users can interact with the RCS API using one of the provided clients or by calling the REST API directly from any programming language. We recommend using one of the provided IDEA StatiCa wrapper clients for .Net or Python.

Client Installation

To install the RCS API in your .Net project you should first add the IdeaStatiCa.RcsApiClient NuGet package to your project. See here for installing NuGet packages in Visual Studio. Note that IdeaStatiCa.Plugin is a dependency of the IdeaStatiCa.RcsApiClient and should automatically be installed, if not it should also be added to your project through NuGet.

Once the NuGet packages are referenced in your project the following using statements should be avaliable:

[!code-csharp]

Note

The .Net RcsApiClient is compatible with projects using .Net6.0 or greater. [!IMPORTANT] The .Net client is set up to work asyncroniously.

To use the RCS API in your Python project first install the IDEA StatiCa RCS Python client into your python environment.

The python client can be installed using pip install the ideastatica-rcs-client for Python

To install the python client open the command line and type the following.

pip install ideastatica-rcs-client

Once installed in the python environment we can use the follow import statements to install in our python project

from ideastatica_rcs_client import idea_statica_setup
from ideastatica_rcs_client import ideastatica_rcs_client