Skip to content

Commit

Permalink
Updated references to git repo
Browse files Browse the repository at this point in the history
Since it's been moved from `ctn-waterloo` to `nengo`.
  • Loading branch information
tbekolay committed Jan 16, 2015
1 parent dc4bc80 commit bb9440e
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 29 deletions.
6 changes: 3 additions & 3 deletions LICENSE.rst
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ This contributor agreement ("Agreement") documents the rights granted
by contributors to Us. To make this document effective, please sign it
and send it to Us by electronic submission, following the instructions
at
<https://github.com/ctn-waterloo/nengo/blob/master/CONTRIBUTORS.rst>.
<https://github.com/nengo/nengo/blob/master/CONTRIBUTORS.rst>.
This is a legally binding document, so please read it carefully before
agreeing to it. The Agreement may cover more than one software project
managed by Us.
Expand All @@ -192,7 +192,7 @@ managed by Us.
to Us in which You own or assert ownership of the Copyright. If You do
not own the Copyright in the entire work of authorship, please follow
the instructions in
<https://github.com/ctn-waterloo/nengo/blob/master/CONTRIBUTORS.rst>.
<https://github.com/nengo/nengo/blob/master/CONTRIBUTORS.rst>.

"Copyright" means all rights protecting works of authorship owned or
controlled by You, including copyright, moral and neighboring rights,
Expand Down Expand Up @@ -323,7 +323,7 @@ You confirm that:
Your parents or guardian sign the Agreement.

(d) You have followed the instructions in
<https://github.com/ctn-waterloo/nengo/blob/master/CONTRIBUTORS.rst>,
<https://github.com/nengo/nengo/blob/master/CONTRIBUTORS.rst>,
if You do not own the Copyright in the entire work of authorship
Submitted.

Expand Down
45 changes: 21 additions & 24 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
.. image:: https://travis-ci.org/ctn-waterloo/nengo.png?branch=master
:target: https://travis-ci.org/ctn-waterloo/nengo
.. 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/ctn-waterloo/nengo/badge.png?branch=master
:target: https://coveralls.io/r/ctn-waterloo/nengo?branch=master
.. 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/ctn-waterloo/nengo/requirements.png?branch=master
:target: https://requires.io/github/ctn-waterloo/nengo/requirements/?branch=master
.. 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
Expand All @@ -28,40 +28,32 @@ Nengo: Large-scale brain modelling in Python
Installation
============

We will be making a release on PyPI soon,
meaning you will be able to ``pip install nengo``.
For now, you can do the following::
To install Nengo, use::

pip install -e git://github.com/ctn-waterloo/nengo.git#egg=nengo
pip install nengo

Nengo supports Python 2.6, 2.7, and 3.3+ in a single codebase.
Nengo depends on `NumPy <http://www.numpy.org/>`_.
If you have difficulty installing,
try install NumPy first.

Usage
=====

TODO
Nengo supports Python 2.6, 2.7, and 3.3+.

Documentation & Examples
========================

Documentation and examples can be found at
`ReadTheDocs <https://nengo.readthedocs.org/en/latest/>`_.
Documentation and examples can be found
`<https://pythonhosted.org/nengo/>`_.


Testing
=======
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

The test suite can take some time to run,
so we recommend install the ``pytest-xdist`` plugin
and running ``py.test --pyargs nengo -n 4``
or however many free CPU cores you have available.

Running individual tests
------------------------

Expand Down Expand Up @@ -89,5 +81,10 @@ for easier debugging. To enable this feature, set the environment variable

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.
2 changes: 1 addition & 1 deletion nengo/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Nengo provides a package for doing large-scale brain modelling in Python.
The source code repository for this package is found at
https://www.github.com/ctn-waterloo/nengo. Examples of models can be found
https://www.github.com/nengo/nengo. Examples of models can be found
in the `examples` directory of the source code repository.
"""

Expand Down
2 changes: 1 addition & 1 deletion nengo/simulator.py
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ def dt(self):
@dt.setter
def dt(self, dummy):
raise AttributeError("Cannot change simulator 'dt'. Please file "
"an issue at http://github.com/ctn-waterloo/nengo"
"an issue at http://github.com/nengo/nengo"
"/issues and describe your use case.")

@property
Expand Down

0 comments on commit bb9440e

Please sign in to comment.