This repository contains the C++ source code for the Numenta Platform for Intelligent Computing (NuPIC). It will eventually contain all algorithms for NuPIC, but is currently in a transition period. For details on building NuPIC within the python environment, please see https://github.com/numenta/nupic.
Important notes:
- For developers (contributing to NuPIC Core) please follow the C++ Development Workflow steps.
$NUPIC_CORE
is the current location of the repository that you downloaded from GitHub.
mkdir -p $NUPIC_CORE/build/scripts
cd $NUPIC_CORE/build/scripts
cmake $NUPIC_CORE/src [-DCMAKE_INSTALL_PREFIX=../release]
Note: The
-DCMAKE_INSTALL_PREFIX=../release
option shown above is optional, and specifies the location wherenupic.core
should be installed. If omitted,nupic.core
will be installed in a system location. Using this option is useful when testing versions ofnupic.core
withnupic
(see NuPIC's Dependency on nupic.core).
cd $NUPIC_CORE/build/scripts
# optionally start a fresh build
make clean
make -j3
Note: The
-j3
option specifies '3' as the maximum number of parallel jobs/threads that Make will use during the build in order to gain speed. However, you can increase this number depending your CPU.
make install
cd $NUPIC_CORE/build/scripts
make tests_cpp_region
make tests_unit
- Open CMake executable.
- Specify the source folder (
$NUPIC_CORE/src
). - Specify the build system folder (
$NUPIC_CORE/build/scripts
), i.e. where IDE solution will be created. - Click
Generate
. - Choose the IDE that interest you (remember that IDE choice is limited to your OS, i.e. Visual Studio is available only on CMake for Windows).
- Open
nupic_core.*proj
solution file generated on$NUPIC_CORE/build/scripts
. - Run
ALL_BUILD
project from your IDE.
- Run any
tests_*
project from your IDE (checkoutput
panel to see the results).