Skip to content

Commit

Permalink
C sharp intallation content
Browse files Browse the repository at this point in the history
  • Loading branch information
ggiraldof committed Dec 17, 2024
1 parent e749ae5 commit 118c937
Showing 1 changed file with 48 additions and 3 deletions.
51 changes: 48 additions & 3 deletions tutorial/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,18 +40,63 @@ Then you can use setuptools to perform the installation:
To test the installation, open a python prompt and import the library:

.. code-bloc:: console
.. code-block:: console
$ python
.. code-block:: python
>>> import simscale_sdk
If you don't receive a 'ModuleNotFoundError', then you should be good to go.
If you don't receive a `ModuleNotFoundError`, then you should be good to go.


C# SDK
------

To Do...
The C# SDK supports the following frameworks:

* .NET Core >= 1.0
* .NET Framework >= 4.6
* Mono/Xamarin >= vNext

The following dependencies must also be satisfied:

* RestSharp 106.10.1
* Json.NET 12.0.1
* JsonSubTypes

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

.. code-block:: console
$ Install-Package RestSharp
$ Install-Package Newtonsoft.Json
$ Install-Package JsonSubTypes
In order to perform the installation, first clone the reposotiry:


.. code-block:: console
$ git clone https://github.com/SimScaleGmbH/simscale-csharp-sdk.git
$ cd simscale-csharp-sdk
Then generate the DLL using your preferred tool

.. code-block:: console
$ dotnet build
The DLL can be found under the bin folder. You can link it in your project, then
include the relevant namespaces:

.. code-block:: csharp
using SimScale.Sdk.Api;
using SimScale.Sdk.Client;
using SimScale.Sdk.Model;

0 comments on commit 118c937

Please sign in to comment.