Skip to content

Commit 08a1642

Browse files
committed
Update README.md
1 parent 5730d27 commit 08a1642

File tree

1 file changed

+22
-1
lines changed

1 file changed

+22
-1
lines changed

README.md

+22-1
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,26 @@ bmi-csharp
33

44
Basic Model Interface for C#.
55

6-
A simple API that can be used to run native simulation components which implement BMI interface [[https://github.com/openearth/bmi]]
6+
A simple API that can be used to run native simulation components which implement BMI interface: [bmi.h](https://github.com/openearth/bmi/blob/master/models/include/bmi.h).
7+
8+
Provides
9+
10+
* C# version of the API: [IBasicModelInterface.cs](https://github.com/openearth/bmi-csharp/blob/master/src/BasicModelInterface/IBasicModelInterface.cs).
11+
* Universal wrapper that can be used to load any native (C/C++/FORTRAN) BMI library: [BasicModelInterfaceLibrary.cs](https://github.com/openearth/bmi-csharp/blob/master/src/BasicModelInterface/BasicModelInterfaceLibrary.cs).
12+
13+
See [BasicModelInterfaceLibraryTest.cs](https://github.com/openearth/bmi-csharp/blob/master/src/BasicModelInterface.Tests/BasicModelInterfaceLibraryTest.cs) for examples on how to use it.
14+
15+
In general:
16+
17+
> var lib = new BasicModelInterfaceLibraryTest("native_library");
18+
>
19+
> lib.Initialize("config_file");
20+
>
21+
> lib.Update(-1);
22+
>
23+
> var a = lib.GetValues("variable_name");
24+
>
25+
> lib.SetValues("variable_name", a);
26+
>
27+
> lib.Finish();
728

0 commit comments

Comments
 (0)