Skip to content

Commit 118c937

Browse files
committed
C sharp intallation content
1 parent e749ae5 commit 118c937

File tree

1 file changed

+48
-3
lines changed

1 file changed

+48
-3
lines changed

tutorial/installation.rst

Lines changed: 48 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,18 +40,63 @@ Then you can use setuptools to perform the installation:
4040
4141
To test the installation, open a python prompt and import the library:
4242

43-
.. code-bloc:: console
43+
.. code-block:: console
4444
4545
$ python
4646
4747
.. code-block:: python
4848
4949
>>> import simscale_sdk
5050
51-
If you don't receive a 'ModuleNotFoundError', then you should be good to go.
51+
If you don't receive a `ModuleNotFoundError`, then you should be good to go.
5252

5353

5454
C# SDK
5555
------
5656

57-
To Do...
57+
The C# SDK supports the following frameworks:
58+
59+
* .NET Core >= 1.0
60+
* .NET Framework >= 4.6
61+
* Mono/Xamarin >= vNext
62+
63+
The following dependencies must also be satisfied:
64+
65+
* RestSharp 106.10.1
66+
* Json.NET 12.0.1
67+
* JsonSubTypes
68+
69+
The DLLs included in the package are probably not the latest available version.
70+
It is recommended to use NuGet to install the latest versions:
71+
72+
.. code-block:: console
73+
74+
$ Install-Package RestSharp
75+
76+
$ Install-Package Newtonsoft.Json
77+
78+
$ Install-Package JsonSubTypes
79+
80+
In order to perform the installation, first clone the reposotiry:
81+
82+
83+
.. code-block:: console
84+
85+
$ git clone https://github.com/SimScaleGmbH/simscale-csharp-sdk.git
86+
87+
$ cd simscale-csharp-sdk
88+
89+
Then generate the DLL using your preferred tool
90+
91+
.. code-block:: console
92+
93+
$ dotnet build
94+
95+
The DLL can be found under the bin folder. You can link it in your project, then
96+
include the relevant namespaces:
97+
98+
.. code-block:: csharp
99+
100+
using SimScale.Sdk.Api;
101+
using SimScale.Sdk.Client;
102+
using SimScale.Sdk.Model;

0 commit comments

Comments
 (0)