Differences

This shows you the differences between two versions of the page.

--- software:grainspotter [2018/07/12 13:44] – matthias
+++ software:grainspotter [2019/09/04 11:38] (current) – smerkel
@@ Line 13: / Line 13: @@
 ==== Installation ====
-You have basically two options for getting GrainSpotter. One is with the help of Anaconda, the other one I forgot. However, Anaconda is the more convenient one, anyway. So first of all, get yourself Anaconda: [[https://www.anaconda.com/download/#linux]]
+You have basically two options for getting GrainSpotter. One is with the help of Anaconda, or from the source.
-Then go to the [[https://anaconda.org/|Anaconda Cloud]] with your browser and search the cloud for //grainspotter//. Then click on //Files// and download the Linux version. Unpack it to a directory of your choice.
+=== Installation with Anaconta ===
-Go back to your browser and click on //Conda//. There is a short code which is necessary to install GrainSpotter. It should be something like this:
+First of all, get yourself Anaconda: [[https://www.anaconda.com/download/#linux]]
-  conda install -c fable grainspotter
+Then go to the [[https://anaconda.org/|Anaconda Cloud]] with your browser and search the cloud for //grainspotter//. Then click on //Files// and download the Linux version. Unpack it to a directory of your choice.
+Go back to your browser and click on //Conda//. There is a short code which is necessary to install GrainSpotter. It should be something like ''conda install -c fable grainspotter''
 Copy the code to your Konsole and follow the installation instructions.
+=== Installation from the source code ===
+The installation requires a C compiler installed in your system.
+  - Download the GrainSpotter source code from [[https://sourceforge.net/p/fable/code/HEAD/tree/GrainSpotter/trunk/]],
+  - Move into the folder with GrainSpotter and type ''make'',
+  - Log-in as administrator (root) and type ''make install''.
+It should work out of the box.
 ===== Running the software =====
@@ Line 27: / Line 39: @@
 To run it, you need a file with the ending //.ini//. When you perform a simulation with [[software:polyxsim|PolyXSim]], it should automatically create such a file. For more information on how it should look like click [[fileformat:ini|here]].
-When you think your .ini file should be fine, it is time to "spot grains" (at least this is what the software should do according to its name). For this type the following to the Konsole:
+When you think your //.ini// file should be fine, it is time to "spot grains" (at least this is what the software should do according to its name). For this type the following to the Konsole:
   grainspotter 'some_file_name'.ini
   or
   GrainSpotter.0.90 'some_file_name'.ini
+The algorithm produces a //.log// file, a //.spe// file and a //.gve// file.
+===== Manual =====
+There is a brief manual online at [[https://sourceforge.net/p/fable/code/HEAD/tree/GrainSpotter/trunk/doc/]].
+Otherwise, you should have a look at the following pages
+  * [[processing:indexing_with_grainspotter|Grain indexing with GrainSpotter]]
+  * [[processing:complex-multi-phase|In the works: indexing a complex dataset with many phases]]