Metadata-Version: 1.0
Name: nengo
Version: 2.0.1
Summary: Tools for making neural simulations using the methods of the Neural Engineering Framework
Home-page: https://github.com/nengo/nengo
Author: Applied Brain Research
Author-email: celiasmith@uwaterloo.ca
License: See LICENSE.rst
Description: .. image:: https://travis-ci.org/nengo/nengo.png?branch=master
          :target: https://travis-ci.org/nengo/nengo
          :alt: Travis-CI build status
        
        .. image:: https://coveralls.io/repos/nengo/nengo/badge.png?branch=master
          :target: https://coveralls.io/r/nengo/nengo?branch=master
          :alt: Test coverage
        
        .. image:: https://requires.io/github/nengo/nengo/requirements.png?branch=master
          :target: https://requires.io/github/nengo/nengo/requirements/?branch=master
          :alt: Requirements Status
        
        .. image:: https://pypip.in/v/nengo/badge.png
          :target: https://pypi.python.org/pypi/nengo
          :alt: Latest PyPI version
        
        .. image:: https://pypip.in/d/nengo/badge.png
          :target: https://pypi.python.org/pypi/nengo
          :alt: Number of PyPI downloads
        
        ********************************************
        Nengo: Large-scale brain modelling in Python
        ********************************************
        
        .. image:: http://c431376.r76.cf2.rackcdn.com/71388/fninf-07-00048-r2/image_m/fninf-07-00048-g001.jpg
          :alt: An illustration of the three principles of the NEF
        
        Installation
        ============
        
        To install Nengo, use::
        
          pip install nengo
        
        Nengo depends on `NumPy <http://www.numpy.org/>`_.
        If you have difficulty installing,
        try installing NumPy first (see below).
        
        Nengo supports Python 2.6, 2.7, and 3.3+.
        
        Developer install
        -----------------
        
        .. code-block:: bash
        
           git clone https://github.com/nengo/nengo.git
           cd nengo
           python setup.py develop --user
        
        If you're using a ``virtualenv``
        (recommended!) then you can omit the ``--user`` flag.
        
        Installing requirements
        -----------------------
        
        Nengo's main requirement is Numpy
        (and optionally Scipy for better performance).
        Currently, installing Numpy from ``pip`` will install
        an unoptimized (slow) version,
        so it is preferable to install Numpy
        using one of the following methods.
        It is important to install Numpy
        before installing the other requirements.
        
        Anaconda
        ^^^^^^^^
        
        Numpy is included as part of the
        [Anaconda](https://store.continuum.io/cshop/anaconda/)
        Python distribution.
        This is a straightforward solution to get Numpy working on
        Windows, Mac, or Linux.
        
        Ubuntu
        ^^^^^^
        
        On Ubuntu and derivatives (e.g. Linux Mint),
        Numpy and Scipy can be installed using ``apt-get``:
        
        .. code-block:: bash
        
           sudo apt-get install python-numpy python-scipy
        
        From source
        ^^^^^^^^^^^
        
        Numpy can be installed from source.
        This is the most complicated method,
        but is also the most flexible
        and results in the best performance.
        See the detailed instructions
        [here](http://hunseblog.wordpress.com/2014/09/15/installing-numpy-and-openblas/).
        
        Other requirements
        ^^^^^^^^^^^^^^^^^^
        
        To install optional requirements to enable additional features, do
        
        .. code-block:: bash
        
           pip install -r requirements.txt
           pip install -r requirements-optional.txt
        
        The testing and documentation requirements
        can be found in similarly named files.
        
        Documentation & Examples
        ========================
        
        Documentation and examples can be found at
        `<https://pythonhosted.org/nengo/>`_.
        
        
        Running tests
        =============
        
        One way to verify that your installation is working correctly
        is to run the unit tests. We use ``py.test``,
        so you can run the Nengo unit tests with::
        
          py.test --pyargs nengo
        
        Running individual tests
        ------------------------
        
        Tests in a specific test file can be run by calling ``py.test`` on that file.
        For example::
        
          py.test nengo/tests/test_node.py
        
        will run all the tests in ``test_node.py``.
        
        Individual tests can be run using the ``-k EXPRESSION`` argument. Only tests
        that match the given substring expression are run. For example::
        
          py.test nengo/tests/test_node.py -k test_circular
        
        will run any tests with `test_circular` in the name, in the file
        ``test_node.py``.
        
        Plotting the results of tests
        -----------------------------
        
        Many Nengo test routines have the built-in ability to plot test results
        for easier debugging. To enable this feature, set the environment variable
        ``NENGO_TEST_PLOT=1``, for example::
        
          NENGO_TEST_PLOT=1 py.test --pyargs nengo
        
        Or, for the current terminal session::
        
          export NENGO_TEST_PLOT=1
          py.test --pyargs nengo
        
        Plots are placed in ``nengo.simulator.plots`` in whatever directory
        ``py.test`` is invoked from.
        
        Contributing
        ============
        
        Please read the ``LICENSE.rst`` file to understand what becoming a contributor entails.
        Once you have read and understood the liscence agreement, add yourself to the ``CONTRIBUTORS.rst`` file.
        Note that all pull requests must be commited by someone else other than the original requestor.
        
        ***************
        Release History
        ***************
        
        .. Changelog entries should follow this format:
        
           version (release date)
           ======================
        
           **section**
        
           - One-line description of change (link to Github issue/PR)
        
        .. Changes should be organized in one of several sections:
        
           - API changes
           - Improvements
           - Behavioural changes
           - Bugfixes
           - Documentation
        
        2.0.1 (January 27, 2015)
        ========================
        
        **Behavioural changes**
        
        - Node functions receive ``t`` as a float (instead of a NumPy scalar)
          and ``x`` as a readonly NumPy array (instead of a writeable array).
          (`#626 <https://github.com/nengo/nengo/issues/626>`_,
          `#628 <https://github.com/nengo/nengo/pull/628>`_)
        
        **Improvements**
        
        - ``rasterplot`` works with 0 neurons, and generates much smaller PDFs.
          (`#601 <https://github.com/nengo/nengo/pull/601>`_)
        
        **Bug fixes**
        
        - Fix compatibility with NumPy 1.6.
          (`#627 <https://github.com/nengo/nengo/pull/627>`_)
        
        2.0.0 (January 15, 2015)
        ========================
        
        Initial release of Nengo 2.0!
        Supports Python 2.6+ and 3.3+.
        Thanks to all of the contributors for making this possible!
        
Platform: UNKNOWN
