Skip to content

Commit b15bd21

Browse files
authored
Update README.md
1 parent 2fa52ae commit b15bd21

File tree

1 file changed

+3
-26
lines changed

1 file changed

+3
-26
lines changed

simulator/README.md

Lines changed: 3 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,6 @@
11
# Simulator package
22

3-
Here you can put the wrappers for simulator used with PET.
3+
This folder contains simple models intended for testing the PET code.
4+
For information about how to add wrappers for new simulators, see the repo:
45

5-
You can build your wrapper (almost) any way you like, but you must follow the following rules:
6-
7-
1. The wrapper must be a Class
8-
2. The Class must contain the following three methods:
9-
10-
```
11-
__init__(self,input_dict):
12-
# parse information from the input.
13-
# Needs to get datatype, reporttype and reportpoint
14-
```
15-
16-
```
17-
Setup_fwd_run(self)
18-
# do whatever initiallization you need.
19-
# Useful to initiallize the self.pred_data variable.
20-
# self.pred_data is a list of dictionaries. Where each list element represents
21-
# a reportpoint and the dictionary should have the datatypes as keys.
22-
# Entries in the dictionary are numpy arrays.
23-
```
24-
25-
```
26-
run_fwd_sim(self, state, member)
27-
# run simulator. Called from the main function using p_map from p_tqdm package.
28-
# Return pred_data if run is successfull, False if run failed.
29-
```
6+
https://github.com/Python-Ensemble-Toolbox/SimulatorWrap

0 commit comments

Comments
 (0)