Skip to content

Home

Jump to bottom
Kenny Chowdhary edited this page Oct 27, 2020 · 18 revisions

Prerequisites

In order for the steps below to be successful, you need:

  • SSH keys setup with github (if you are working behind a firewall, set the proper proxies)
  • C, C++11 compiler (this was tested with GCC9.2.0);
  • CMake >= 3.11.0;
  • Bash >= 3.2.57.
  • Python (min version TBD), with NumPy, SciPy, Numba, and Pytest

1. Prep

(a) Create (or choose) a directory where you want to clone all repos, e,g.:

mkdir $HOME/pressio_repos

(b) To make things easier and cleaner below, create environment variables:

export PRESSIO_REPOS=$HOME/pressio_repos
export PRESSIO_BUILDS=$HOME/pressio_builds

(c) Unless you already have them, set the following compilers environment variable:

export CC=<path-to-your-C-compiler>
export CXX=<path-to-your-CXX-compiler>

These are needed because CC and CXX are used to do all the builds.

2. Cloning

Clone the needed repos as follows:

cd ${PRESSIO_REPOS}

git clone [email protected]:Pressio/pressio.git
git clone [email protected]:Pressio/pressio-builder.git
git clone [email protected]:Pressio/pressio4py.git

3. Install TPLs

Run the following command:

cd ${PRESSIO_REPOS}/pressio-builder
bash ./main_tpls.sh -dryrun=no -build-mode=Debug \
     -target-dir=${PRESSIO_BUILDS} -tpls=pybind11,eigen

This step should create a directory tree with:

${PRESSIO_BUILDS}/eigen/install
${PRESSIO_BUILDS}/pybind11/{install, build}

which looks like the following using tree:

├── pressio_builds
│   ├── eigen
│   │   ├── eigen-3.3.7
│   │   ├── eigen-3.3.7.tar.gz
│   │   └── install
│   └── pybind11
│       ├── build
│       ├── install
│       └── pybind11

4. Install pressio

cd ${PRESSIO_REPOS}/pressio-builder
./main_pressio.sh -dryrun=no \
  -pressio-src=${PRESSIO_REPOS}/pressio \
  -target-dir=${PRESSIO_BUILDS} \
  -cmake-generator-name=default_pybind \
  -eigen-path=${PRESSIO_BUILDS}/eigen/install \
  -pybind11-path=${PRESSIO_BUILDS}/pybind11/install

5. Time to build pressio4py

cd ${PRESSIO_BUILDS}

bdirname=pressio4py-build
rm -rf ${bdirname} && mkdir ${bdirname} && cd ${bdirname}
cmake -DCMAKE_VERBOSE_MAKEFILE:BOOL=TRUE \
      -DCMAKE_INSTALL_PREFIX=${PRESSIO_BUILDS}/pressio4py-install \
      -DCMAKE_CXX_COMPILER=${CXX} \
      -DCMAKE_BUILD_TYPE=Release \
      \
      -DEIGEN_INCLUDE_DIR=${PRESSIO_BUILDS}/eigen/install/include/eigen3 \
      -DPRESSIO_INCLUDE_DIR=${PRESSIO_BUILDS}/pressio/install/include \
      -DPYBIND11_DIR=${PRESSIO_BUILDS}/pybind11/install \
      ${PRESSIO_REPOS}/pressio4py
make -j4 
make install
cd ..

You should have dynamic libraries inside ${PRESSIO_BUILDS}/pressio4py-install that you can load from Python.

6. Testing

After building, you can do:

cd ${PRESSIO_BUILDS}/pressio4py-build
pytest
Clone this wiki locally