Skip to content

Commit 3349af6

Browse files
committed
Added a quick README.txt into the examples folder
1 parent c73c490 commit 3349af6

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

examples/README.txt

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
README FOR '[PRaLine]/examples/' DIRECTORY
2+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3+
4+
This directory contains example intermediate files (test_input.p, test_input.txt) for re-creating some of the plots of Graziani et al. 2017.
5+
6+
More information on using and interpreting these examples can be found in the main documentation for PRaLine, located in the directory above at '[PRaLine]/README.md'.
7+
8+
As described in the main documentation, analysis of the file can be performed via the command line:
9+
lin-analyze test_input.p
10+
lin-reconstruct test_input.p
11+
12+
The plots generated (after 4000 iterations) after calling these functions should match those in the '[PRaLine]/examples/reference_images' directory.

0 commit comments

Comments
 (0)