Installing the Numenta Platform for Intelligent Computing
This section helps you with the process of installing the Numenta Platform onto your computer system.
Installing NuPIC
Prior to installing the platform on to your system, check out the System Requirements and make sure you have a compatible system. If you do not have a Numenta-compatible system, please read this FAQ.
This describes how to update your existing NuPIC Installation.
Click here for more information.
Directory Structure Tour
Now that you have installed the Numenta Platform, let us walk you through directory structure.
Overview
On Macintosh and Linux, NuPIC is distributed as a compressed tar file named:
nupic-<version>-<architecture>.tar.gz
where <version> is the version number and <architecture> is one of linux32, linux64, darwin and darwin86. This file extracts into a directory named nupic-<version>-<architecture>. This directory can be installed anywhere, but on Unix, Numenta recommends that you install it as a subdirectory of $HOME/nta as described in the installation instructions.
On Windows, NuPIC is distributed as an executable installer:
nupic-1.6.1-win32_installer.exe
Top Level
README.TXT contains release notes for this version of the software.
bin subdirectory
This directory contains NuPIC executable programs.
- numenta_runtime is the Numenta Runtime Engine. It can play the role of a Supervisor or a Node Processor.
- launcher is a Numenta tool for starting up the runtime in different configurations.
- Unix Only: orted is the Open Run Time Environment Daemon from Open MPI (www.open-mpi.org), which Numenta uses for underlying process management and interprocess communication.
- Unix Only: orterun is a program for starting Open MPI programs.
lib subdirectory
This directory contains NuPIC plugins and python modules used with NuPIC.
- libLearningPlugin.so/dll/dylib contains the learning node types provided by Numenta, including the Zeta1 and Zeta1Top nodes.
- libBasicPlugin.so/dll/dylib contains all non-learning node types (except for Python nodes) provided by Numenta, including VectorFileEffector, VectorFileSensor, and PassThroughNode.
- python2.5/site-packages contains all Python packages provided by Numenta. The nupic python module contains NuPIC specific functionality. NuPIC also uses the Python Imaging Library (PIL), the Numerical Python Library (numpy), the matplotlib plotting package, enthought.traits and wx.
share subdirectory
- doc is a directory that at this time contains licenses for 3rd party software used by NuPIC.
- openmpi is a directory used by Open MPI.
- projects is a directory containing the example HTM applications -- bitworm, waves, flu, pictures and more.
- vision is a directory to highlight our vision framework experiments.
