Installation¶

The SimScale SDK is hosted and published in GitHub. Following are the instructions for the installation of the Python and C# libraries.

Python SDK¶

The SDK library requires Python version >= 3.6. The installation can be done with pip, directly from the repository, or via setuptools from source.

When installing python packages, it is recommended that you make use of virtual environments.

To install with pip, you can run the command:

pip install git+https://github.com/SimScaleGmbH/simscale-python-sdk.git

If you want to install an specifiy version, you can run:

pip install git+https://github.com/SimScaleGmbH/simscale-python-sdk.git@10.0.0

To install from source, first clone the repository:

git clone https://github.com/SimScaleGmbH/simscale-python-sdk.git

Then you can use setuptools to perform the installation:

cd simscale-python-sdk

python setup.py isntall --user

To test the installation, open a python prompt and import the library:

python

import simscale_sdk

If you don’t receive a ModuleNotFoundError, then you should be good to go.

The C# SDK supports the following frameworks:

The following dependencies must also be satisfied:

The DLLs included in the package are probably not the latest available version. It is recommended to use NuGet to install the latest versions:

Install-Package RestSharp

Install-Package Newtonsoft.Json

Install-Package JsonSubTypes

In order to perform the installation, first clone the reposotiry:

git clone https://github.com/SimScaleGmbH/simscale-csharp-sdk.git

cd simscale-csharp-sdk

Then generate the DLL using your preferred tool

dotnet build

The DLL can be found under the bin folder. You can link it in your project, then include the relevant namespaces:

using SimScale.Sdk.Api;
using SimScale.Sdk.Client;
using SimScale.Sdk.Model;