README.md 3.71 KB
Newer Older
1
# OpenWalnut
2 3 4 5

OpenWalnut is an open source tool for multi-modal medical and brain data
visualization. Its universality allows it to be easily extended and used in a
large variety of application cases. It is both, a tool for the scientific user
6
and a powerful framework for the visualization researcher. OpenWalnut is
7 8 9 10 11
licensed under the terms of the GNU Lesser General Public License. Written
entirely in Standard C++ and using a number of portable libraries (e.g.
OpenSceneGraph and  Qt), it runs on all Windows platforms, OSX, and
GNU/Linux operating systems.

12
- Please refer to http://www.openwalnut.org for extensive documentation 
13 14
  and information.

15
# AUTHORS AND CONTRIBUTORS
16

17
See the files "[AUTHORS](AUTHORS)" and "[CONTRIBUTORS](CONTRIBUTORS)".
18

19
# LICENSE
20

Alexander Wiebel's avatar
Alexander Wiebel committed
21
OpenWalnut is licensed under the terms of the LGPLv3.
22
See the "[COPYING](COPYING)" and "[COPYING.LESSER](COPYING.LESSER)" files.
23

24
# CONTACT
25 26

If you have questions, comments, problems or find Bugs, contact us using:
27 28

* **Mailing list**: openwalnut@lists.informatik.uni-leipzig.de
Alexander Wiebel's avatar
Alexander Wiebel committed
29
    * Very low traffic at the moment ( < 1 mail per month). You might want to try the developer mailing list below.
30 31 32 33
    * To join the list visit http://lists.informatik.uni-leipzig.de/mailman/listinfo/openwalnut and follow the instructions.
* **Developer Mailing list**: openwalnut-dev@lists.informatik.uni-leipzig.de
    * Medium traffic ( < 10 mails per week).
    * To join the list visit http://lists.informatik.uni-leipzig.de/mailman/listinfo/openwalnut-dev and follow the instructions.
34

35
# INSTALLING
36 37

You have several options for installing OpenWalnut.
38 39 40

* Build it -> see next section
* Download a binary archive from our website and extract it
41
    * Inside the extracted directory, run bin/openwalnut
42 43 44
* Download one of our binary packages for your distribution
* Check the NeuroDebian repository
    * We have been working on a OpenWalnut package which has been
45 46
      released in NeuroDebian (http://neuro.debian.net/)

47
# BUILDING
48

49 50
As you currently read this README, we presume that you already have the source.
If not, check http://www.openwalnut.org. There, you can download source archives
51
and get the URL to our git repository.
52

53
## Required Dependencies:
54

55
* Qt (Preferrably Qt5, build support also for Qt4 >= 4.6) 
56
* OpenSceneGraph (>= 2.8.0)
57
* Boost (>= 1.46.0)
58 59
* NIfTI library
* Eigen library
60

61
## Compilation on Unix-like systems:
62 63 64 65

If you have installed all required third party libs, you can compile OpenWalnut
by using the common routine:

66
```sh
67 68 69
cd build
cmake ../src
make
70
make install -- this is optional and installs everything.
71
```
72 73 74

After that, OpenWalnut can be used inside the build directory.

75 76
If you want to install only a part of OpenWalnut, you can issue

77
```sh
78
make list_install_targets
79
```
80 81 82

The listed targets will then only install the specified part.

83
## Compilation on Windows and Mac:
84

85
This is a little bit more complicated. We provide a step-by-step explanation
86 87
on http://www.openwalnut.org.

88
# BINARY DISTRIBUTION
Sebastian Eichelbaum's avatar
[DOC]  
Sebastian Eichelbaum committed
89 90 91 92

If you have received OpenWalnut in binary form, you can always acquire the
code at http://www.openwalnut.org or from your distributor. In the binary
packages we provide, we might include open source, third-party libraries. 
Alexander Wiebel's avatar
Alexander Wiebel committed
93
If so, the licenses are re-distributed along the libraries. We did not modify
Sebastian Eichelbaum's avatar
[DOC]  
Sebastian Eichelbaum committed
94 95 96
the sources. However, you can get the sources of these libraries by contacting
us.

97
# USING
98 99 100 101

After starting OpenWalnut, press F1 to get an introductory help. More 
information is available online at http://www.openwalnut.org

102
# DEVELOPING
103 104

If you want to develop modules for OpenWalnut, have a look at 
105
[src/modules/template](src/modules/template), which contains an extensively documented example module.
106
More information is available online. The wiki, especially the development
107
section, is very helpful.