Changeset 309

Timestamp:

11/09/08 10:20:57 (2 months ago)

Author:

emuller

Message:

Added docstring for top-level module.

Files:

• trunk/src/__init__.py (modified) (1 diff)

trunk/src/__init__.py

@@ +1 @@
+"""
+NeuroTools
+==========
+
+NeuroTools is not a neural simulator, but rather a collection of tools
+to support all tasks associated with a neural simulation project which
+are not handled by the simulation engine.
+
+For more information see:
+
+http://neuralensemble.org/NeuroTools
+
+
+
+Available subpackages
+---------------------
+
+NeuroTools functionality is modularized as follows: 
+
+signals    - provides core classes for manipulation of spike trains and analog signals. 
+spike2     - offers an easy way for reading data from CED's Spike2 Son files. 
+parameters - contains classes for managing large, hierarchical parameter sets. 
+analysis   - cross-correlation, tuning curves, frequency spectrum, etc.
+stgen      - various stochastic process generators relevant for Neuroscience 
+             (OU, poisson, inhomogenous gamma, ...). 
+utilities  - miscellaneous stuff, like SRB access.
+io         - NeuroTools support for reading and writing of files in various formats. 
+plotting   - routines for plotting and visualization.
+
+
+Sub-package specific documentation is available by importing the
+sub-package, and requesting help on it:
+
+>>> import NeuroTools.signals
+>>> help(NeuroTools.signals)
+
+
+"""
+
+
+
-__all__ = ['analysis', 'parameters', 'plotting', 'sandbox', 'signals', 'stgen', 'io']
-