Skip to content

Commit 52ecac9

Browse files
authored
Create README.md
1 parent 9a03cdc commit 52ecac9

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

model_library/README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
Sample Model Collection
2+
=======================
3+
4+
For collecting real world models for reflectometry, if possibel from published work.
5+
6+
Please create one folder and a corresponding description file:
7+
{your_model}/*.* # all files relevant for the model, data, fit, images, etc.
8+
{your_model}.md
9+
10+
As template for the model description you can use the followin:
11+
12+
13+
your_model
14+
==========
15+
16+
Software
17+
--------
18+
19+
Program used for refinement with version.
20+
21+
Reference
22+
---------
23+
24+
Publication linked to the model.
25+
26+
Description
27+
-----------
28+
29+
Please explain here what the model is describing, how refinement was done and what you learned about your system.
30+
31+
ORSO Model Language Description
32+
-------------------------------
33+
34+
If possible a model in YAML that describes the system in the ORSO model language.
35+
36+
```yaml
37+
38+
```

0 commit comments

Comments
 (0)