root/trunk/src/__init__.py @ 687

Revision 687, 2.2 KB (checked in by apdavison, 3 years ago)

Updated connection handling in nest module to work with NEST version 1.9.8498. Will not now work with previous NEST versions

  • Property svn:eol-style set to native
  • Property svn:keywords set to Revision Id
Line 
1"""
2PyNN (pronounced 'pine' ) is a Python package for simulator-independent
3specification of neuronal network models.
4
5In other words, you can write the code for a model once, using the PyNN API, and
6then run it without modification on any simulator that PyNN supports.
7
8To use PyNN, import the particular simulator module you wish to use, e.g.
9    import pyNN.neuron as sim
10all subsequent code in the `sim` namespace will then have the same behaviour
11independent of simulator.
12
13Functions for simulation set-up and control:
14    setup()
15    run()
16    end()
17    get_time_step()
18    get_current_time()
19    get_min_delay()
20    get_max_delay()
21    rank()
22    num_processes()
23    list_standard_models()
24   
25Functions for creating, connecting, modifying and recording from neurons
26(low-level interface):
27    create()
28    connect()
29    set()
30    record()
31    record_v()
32    record_gsyn()
33   
34Classes for creating, connecting, modifying and recording from neurons
35(high-level interface):
36    Population
37    Projection
38    Connectors: AllToAllConnector, OneToOneConnector, FixedProbabilityConnector,
39                DistanceDependentProbabilityConnector, FixedNumberPreConnector,
40                FixedNumberPostConnector, FromListConnector, FromFileConnector
41    Standard cell types: IF_curr_exp, IF_curr_alpha, IF_cond_exp, IF_cond_alpha,
42                IF_cond_exp_gsfa_grr, IF_facets_hardware1, HH_cond_exp,
43                EIF_cond_alpha_isfa_ista, EIF_cond_exp_isfa_ista,
44                SpikeSourcePoisson, SpikeSourceArray, SpikeSourceInhGamma
45                (not all cell types are available for all simulator backends).
46    Synaptic plasticity: SynapseDynamics, TsodyksMarkramMechanism, STDPMechanism,
47                AdditiveWeightDependence, MultiplicativeWeightDependence,
48                AdditivePotentiationMultiplicativeDepression,
49                GutigWeightDependence, SpikePairRule
50                (not all combinations area available for all simulator backends).
51    Current injection: DCSource, StepCurrentSource, NoisyCurrentSource.
52
53Available simulator modules:
54    nest
55    neuron
56    pcsim
57    brian
58
59Other modules:
60    utility
61    random
62
63"""
64
65__version__ = '0.6.0pre ( $Rev$)'.replace(' $','')
66__all__ = ["common", "random", "nest", "neuron", "pcsim", "brian", "recording"]
67
Note: See TracBrowser for help on using the browser.