root/trunk/README

Revision 328, 2.8 kB (checked in by emuller, 2 months ago)

Copyright to all authors added to LICENSE, modified to be inline with
GPL instructions.

Line 
1
2 NeuroTools
3 ==========
4
5 NeuroTools is not a neural simulator, but rather a collection of tools
6 to support all tasks associated with a neural simulation project which
7 are not handled by the simulation engine. NeuroTools is written in
8 Python, and works best with PyNN, or one of the growing list of
9 simulation engines with a Python front-end such as NEURON, NEST,
10 PCSIM, FACETS Neuromorphic VLSI, Brian, MOOSE/GENESIS,
11 Neurospaces/GENESIS. NeuroTools provides modules to facilitate
12 simulation setup, parameterization and instrumentation, and data
13 management, analysis and visualization. The data-related tools are
14 equally suited to analysis of experimental data, although that is not
15 the primary motivation for their development.
16
17 NeuroTools aims to:
18
19 1. increase the productivity of individual modellers by automating,
20    simplifying, and establishing best-practices for common tasks,
21
22 2. increase the productivity of the neuroscience modelling
23    community by reducing the amount of code duplication across
24    simulation communities,
25
26 3. increase the reliability of data
27    analysis tools leveraging Linus's law: "given enough eyeballs, all
28    bugs are shallow."
29
30
31
32 License
33 =======
34
35 Copyright (C) 2008  Daniel Bruederle, Andrew Davison, Jens Kremkow
36 Laurent Perrinet, Michael Schmuker, Eilif Muller, Eric Mueller, Pierre Yger
37
38 NeuroTools is free software; you can redistribute it and/or modify
39 it under the terms of the GNU General Public License as published by
40 the Free Software Foundation; either version 2 of the License, or
41 (at your option) any later version.
42
43 This program is distributed in the hope that it will be useful,
44 but WITHOUT ANY WARRANTY; without even the implied warranty of
45 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
46 GNU General Public License for more details.
47
48 You should have received a copy of the GNU General Public License along
49 with this program; if not, write to the Free Software Foundation, Inc.,
50 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
51
52 The GNU General Public License does not permit this software to be
53 redistributed in proprietary programs.
54
55 See source:trunk/LICENSE.
56
57
58 Contributing to NeuroTools
59 ==========================
60
61 If you are interested in participating in NeuroTools development, please see
62 the webpage at http://neuralensemble.org/NeuroTools
63
64
65
66 Installation
67 ============
68
69 For installation instructions, see source:trunk/INSTALL.
70
71
72
73 Documentation
74 =============
75
76
77 For documentation see source:trunk/doc
78 and
79 http://neuralensemble.org/trac/NeuroTools.
80
81 For examples see source:trunk/examples.
82
83 For more information, see the NeuroTools trac http://neuralensemble.org/trac/NeuroTools.
84
85
86
87 Reporting Bugs
88 ==============
89
90 The NeuroTools project site is also a trac-based (http://trac.edgewall.org) bug management system.
91
92 Please report bugs by submitting a "New Ticket" at
93 http://neuralensemble.org/trac/NeuroTools
Note: See TracBrowser for help on using the browser.