Skip to content

Latest commit

 

History

History
84 lines (52 loc) · 1.84 KB

DeveloperGuide.md

File metadata and controls

84 lines (52 loc) · 1.84 KB
Raw

SHIFT Python Developer Guide

Ubuntu and macOS

Required Libraries

Please refer to the other required libraries in the SHIFT Developer Guide.

SHIFT Core Client

Use the installer in the root folder of the SHIFT project:

  • In the Terminal: sudo ./install -m LC

pybind11:

Choose a location to keep the pybind11 source files (for debugging purposes), e.g. a "C++" folder in your home directory, and then:

git clone https://github.com/pybind/pybind11.git
cd pybind11
git checkout tags/v2.2.4 # v2.3.0 has a bug with char enums
mkdir build
cd build

cmake -DCMAKE_CXX_STANDARD=17 -DCMAKE_BUILD_TYPE=RelWithDebInfo -DPYBIND11_PYTHON_VERSION=3.7 ..

make
sudo make install

To make CMAKE find pybind11, this solution may work:

pip install "pybind11[global]"

SHIFT Python Installation

Depending on how python was installed in your system, you may need to use sudo in the commands below.

To install SHIFT Python:

  • In the Terminal: # python3 setup.py install

To uninstall SHIFT Python:

  • In the Terminal: # pip3 uninstall shift

To clean the build directories:

  • In the Terminal: # python3 setup.py clean

Windows

[TODO] Required Libraries

[TODO] SHIFT Python Installation

2023 Update

Installing local changes:

python3 setup.py clean python3 setup.py install

You can now see your local changes (in shift-python): python3 import shift ....

Installing to conda environment

python3 setup.py bdist_wheel pip install dist/shift-2.0.1-py3.7-*.whl

You can now see these changes globally when conda env is active