Installation for Linux and Mac OS-X users¶
Currently there is no distribution package of BigARTM for Linux. BigARTM had been tested on several Linux distributions, and it is known to work well, but you have to get the source code and compile it locally on your machine.
Building BigARTM requires the following components:
To simplify things, you may type:
- On deb-based distributions:
sudo apt-get install git make cmake build-essential libboost-all-dev
- On rpm-based distributions:
sudo yum install git make cmake gcc-c++ glibc-static libstdc++-static boost boost-static python(for Fedora 22 or higher use
- On Mac OS distributions:
brew install git cmake boost
Download sources and build¶
Clone the latest BigARTM code from our github repository, and build it via CMake as in the following script.
cd ~ git clone --branch=stable https://github.com/bigartm/bigartm.git cd bigartm mkdir build && cd build cmake .. make
Note for Linux users: By default building
bigartm requiers static versions of Boost, C and C++ libraries.
To alter it, run
cmake command with option
To install command-line utility, shared library module and Python interface for BigARTM, you can type:
sudo make install
Normally this will install:
bigartmutility into folder
- shared library
artm.dylibfor Max OS-X) into folder
- Python interface for BigARTM into Python-specific system directories, along with necessary dependencies.
If you want to alter target folders for binary and shared library objects,
you may specify common prefix while running
Configure BigARTM Python API¶
If you want to use only Python interface for BigARTM, you may run following commands:
# Step 1 - install Google Protobuf as dependency cd ~/bigartm/3rdparty/protobuf/python sudo python setup.py install # Step 2 - install Python interface for BigARTM cd ~/bigartm/python sudo python setup.py install # Step 3 - point ARTM_SHARED_LIBRARY variable to libartm.so (libartm.dylib) location export ARTM_SHARED_LIBRARY=~/bigartm/build/lib/libartm.so # for linux export ARTM_SHARED_LIBRARY=~/bigartm/build/lib/libartm.dylib # for Mac OS X
We strongly recommend system-wide installation as
there is no need to keep BigARTM code after it, so you may safely
If you build BigARTM in existing folder
build (e.g. you built BigARTM before) and encounter any errors,
it may be due to out-of-date file
CMakeCache.txt in folder
build. In that case we strongly recommend
to delete this file and try to build again.
Using BigARTM Python API you can encounter this error:
Traceback (most recent call last): File "<stdin>", line 1, in <module> File "build/bdist.linux-x86_64/egg/artm/wrapper/api.py", line 19, in __init__ File "build/bdist.linux-x86_64/egg/artm/wrapper/api.py", line 53, in _load_cdll OSError: libartm.so: cannot open shared object file: No such file or directory Failed to load artm shared library. Try to add the location of `libartm.so` file into your LD_LIBRARY_PATH system variable, or to set ARTM_SHARED_LIBRARY - a specific system variable which may point to `libartm.so` file, including the full path.
This error indicates that BigARTM’s python interface can not locate libartm.so (libartm.dylib) files.
In such case type