Skip to content

Added Mac installation instructions and eigen #256

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
neubig merged 1 commit into from
Jan 18, 2017
Merged

Added Mac installation instructions and eigen #256

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions doc/source/install.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,22 @@ Prerequisites

DyNet relies on a number of external libraries including Boost, CMake,
Eigen, and Mercurial (to install Eigen). Boost, CMake, and Mercurial can
be installed from standard repositories, for example on Ubuntu Linux:
be installed from standard repositories.

For example on **Ubuntu Linux**:

::

sudo apt-get install libboost-all-dev cmake mercurial

Or on OSX, first make sure the Apple Command Line Tools are installed, then
Or on **Mac OSX**, first make sure the Apple Command Line Tools are installed, then
get Boost, CMake, and Mercurial with either homebrew or macports:

::

xcode-select --install
brew install boost cmake hg
sudo port install boost cmake mercurial
brew install boost cmake hg # Using homebrew.
sudo port install boost cmake mercurial # Using macports.

To compile DyNet you also need the `development version of the Eigen
library <https://bitbucket.org/eigen/eigen>`__. **If you use any of the
Expand All @@ -32,6 +34,11 @@ the following command:
::

hg clone https://bitbucket.org/eigen/eigen/ -r 346ecdb
cd eigen
mkdir build && cd build
cmake ..
make install # sudo permissions might be necessary on Linux.
cd ../..

The `-r NUM` specified a revision number that is known to work.
Adventurous users can remove it and use the very latest version, at the risk of the code breaking / not compiling.
Expand All @@ -55,6 +62,7 @@ to generate the makefiles
cd build
cmake .. -DEIGEN3_INCLUDE_DIR=/path/to/eigen


Then compile, where "2" can be replaced by the number of cores on your
machine

Expand Down