Skip to content

Development Guide

This page provides instructions for developers working on the grid-fit library.

  1. Clone the repository: 
    git clone https://github.com/rae-gh/grid-fit.git
cd grid-fit
  2. (Recommended) Create and activate a conda environment: 
    conda create -n gridfit-dev -c conda-forge python=3.10 cmake make gxx_linux-64 -y
conda activate gridfit-dev
conda install -c conda-forge pybind11 pytest numpy scipy -y
Rscript -e 'install.packages("devtools")'
  3. Run the install script: 
    ./install.sh

The install.sh script will: - Clean previous builds - Build the C++ core - Build and install the Python and R bindings - Run example scripts for C++, Python, and R - Print output from all three so you know everything works

If you see output from all three languages, your setup is correct!

Manual Developer Setup (Advanced)

If you want to set up a development environment for editing and testing code, follow these steps:

  1. Clone the repository: 
    git clone https://github.com/rae-gh/grid-fit.git
cd grid-fit
  2. (Optional) Create and activate a conda environment: 
    conda create -n gridfit-dev -c conda-forge python=3.10 cmake make gxx_linux-64 -y
conda activate gridfit-dev
conda install -c conda-forge pybind11 pytest numpy scipy -y
Rscript -e 'install.packages("devtools")'
  3. Install the Python package in editable mode: 
    python -m pip install -e .
  4. Build the C++ core and R package as needed (see CMakeLists.txt and R/README).

Manual Testing Before Push

Python

Run the integration tests with pytest: 

pytest tests/python

R

Run the R integration test script: 

Rscript tests/R/test_trilinear.R

Make sure both tests pass before pushing changes.

Pre-commit Hooks

This project uses pre-commit hooks to help maintain code quality for Python and C++ files. Hooks will automatically check formatting and linting before each commit.

Setup

  1. Install pre-commit (if not already): 
    python -m pip install pre-commit
  2. Install the hooks: 
    pre-commit install

Now, every time you commit, black and flake8 will check Python files, and clang-format will check C++ files. You can add more hooks or languages as needed.