Skip to content

Commit

Permalink
Address suki comments
Browse files Browse the repository at this point in the history
Signed-off-by: Adam Li <[email protected]>
  • Loading branch information
adam2392 committed Jul 19, 2024
1 parent be7681a commit 088f9cf
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions DEVELOPING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,13 @@
- [Requirements](#requirements)
- [Setting up your development environment](#setting-up-your-development-environment)
- [Building the project from source](#building-the-project-from-source)
- [Summary: Building locally with Meson For developers](#summary-building-locally-with-meson-for-developers)
- [Development Tasks](#development-tasks)
- [Advanced Updating submodules](#advanced-updating-submodules)
- [Cython and C++](#cython-and-c)
- [Making a Release](#making-a-release)
- [Releasing on PyPi for pip installs](#releasing-on-pypi-for-pip-installs)
- [Releasing documentation](#releasing-documentation)

<!-- /TOC -->

Expand Down Expand Up @@ -82,15 +85,15 @@ the unit-tests should run.

Summary: Building locally with Meson (For developers)
-----------------------------------------------------
Make sure you have the necessary packages installed
Make sure you have the necessary packages installed.

# install build dependencies
pip install -r build_requirements.txt

# you may need these optional dependencies to build scikit-learn locally
conda install -c conda-forge joblib threadpoolctl pytest compilers llvm-openmp

We use the ``spin`` CLI to abstract away build details:
``YOUR_PYTHON_VERSION`` below should be any of the acceptable versions of Python for treeple. We use the ``spin`` CLI to abstract away build details:

# run the build using Meson/Ninja
./spin build
Expand All @@ -107,7 +110,7 @@ We use the ``spin`` CLI to abstract away build details:

# you will need to double check the build-install has the proper path
# this might be different from machine to machine
export PYTHONPATH=${PWD}/build-install/usr/lib/python3.9/site-packages
export PYTHONPATH=${PWD}/build-install/usr/lib/python<YOUR_PYTHON_VERSION>/site-packages

# run specific unit tests
./spin test -- treeple/tree/tests/test_tree.py
Expand All @@ -126,7 +129,7 @@ You can also do the same thing using Meson/Ninja itself. Run the following to bu
# install treeple package
meson install -C build

export PYTHONPATH=${PWD}/build/lib/python3.9/site-packages
export PYTHONPATH=${PWD}/build/lib/python<YOUR_PYTHON_VERSION>/site-packages

# to check installation, you need to be in a different directory
cd docs;
Expand Down

0 comments on commit 088f9cf

Please sign in to comment.