Skip to content

Commit

Permalink
Make install info in README.rst agree with that in INSTALL.rst, add l…
Browse files Browse the repository at this point in the history
…ogo.
  • Loading branch information
lebedov committed Feb 5, 2015
1 parent 65776eb commit b96a473
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 16 deletions.
59 changes: 43 additions & 16 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. -*- rst -*-
Neurokernel
===========
.. image:: https://raw.githubusercontent.com/neurokernel/neurokernel/master/doc/source/_static/logo.png
:alt: Neurokernel

Package Description
-------------------
Expand All @@ -12,15 +12,34 @@ the fruit fly brain and executing them on multiple NVIDIA GPUs.
:target: http://prime4commit.com/projects/98
:alt: Support the project

Quick Start
-----------
Prerequisites
-------------
Neurokernel requires Python 2.7, at least one NVIDIA GPU, NVIDIA's `GPU drivers
<http://www.nvidia.com/content/drivers/>`_, and `CUDA
<http://www.nvidia.com/object/cuda_home_new.html>`_ 5.0 or later.
<http://www.nvidia.com/object/cuda_home_new.html>`_ 5.0 or later. To check what
GPUs are in your system, you can use the `inxi
<https://code.google.com/p/inxi/>`_ command available on most Linux
distributions::

inxi -G

You can verify that the drivers are loaded as follows::

lsmod | grep nvidia

If no drivers are present, you may have to manually load them by running
something like::

modprobe nvidia

as root.

Quick Start
-----------
Make sure you have `pip <http://pip.pypa.io>`_ installed (preferably
in a `virtualenv <http://virtualenv.pypa.io>`_); once you do, install the
following dependencies as follows::
following dependencies in the specified order (replace `pip` with the path to
the copy of `pip` in your `virtualenv`)::

pip install numpy
pip install cython
Expand All @@ -29,9 +48,9 @@ following dependencies as follows::
pip install pycuda

If installation of PyCUDA fails because some of the CUDA development files or
libraries are not found, you may need to specify where they are explicitly. For
example, if CUDA is installed in ``/usr/local/cuda/``, try installing PyCUDA as
follows::
libraries are not found, you may need to specify where they are explicitly. For
example, if CUDA is installed in ``/usr/local/cuda/``, try installing PyCUDA
as follows::

CUDA_ROOT=/usr/local/cuda/ CFLAGS=-I${CUDA_ROOT}/include \
LDFLAGS=-L${CUDA_ROOT}/lib64 pip install pycuda
Expand All @@ -44,14 +63,13 @@ Linux. If you continue to encounter installation problems, see the `PyCUDA Wiki
You will also need to have `ffmpeg <http://www.fmpeg.org>`_ or `libav
<http://libav.org>`_ installed to generate some of the demo visualizations.

Run the following to install the remaining dependencies and the latest
Neurokernel code::
Run the following to install the remaining Python package dependencies listed in
`setup.py` and the latest Neurokernel code: ::

git clone https://github.com/neurokernel/neurokernel.git
pip install -e git+./neurokernel#egg=neurokernel

If you have all of the requirements listed in ``INSTALL.rst`` installed,
you can also install the downloaded code using::
You can also install the code directly as follows: ::

cd neurokernel/
python setup.py install
Expand All @@ -62,9 +80,18 @@ it)::
cd neurokernel/
python setup.py develop

Check out the demos in ``neurokernel/examples`` subdirectory and
their corresponding `IPython notebooks <http://ipython.org/notebook.html>`_
in ``neurokernel/notebooks``.
Building the Documentation
--------------------------
To build the HTML documentation, you will need to install

* `sphinx <http://sphinx-doc.org>`_ 1.2 or later.
* `sphinx_rtd_theme <https://github.com/snide/sphinx_rtd_theme>`_ 0.1.6 or
later.

Once these are installed, run the following: ::

cd neurokernel/docs
make html

Supported Platforms
-------------------
Expand Down
Binary file added docs/source/_static/logo.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b96a473

Please sign in to comment.