Skip to content

Latest commit

 

History

History
84 lines (59 loc) · 3.12 KB

CONTRIBUTING.md

File metadata and controls

84 lines (59 loc) · 3.12 KB

Contributing to Our Project

Thank you for considering contributions to our project! Here's how you can help:

Setting Up for Development

We're using scikit-build-core for our build system and building using cmake. You'll need a handful of system dependencies to build locally.

Linux

On Linux, install the following OS dependencies with:

sudo apt-get update
sudo apt-get install libblas-dev libboost-filesystem-dev libboost-system-dev libboost-thread-dev libglu1-mesa-dev libsuitesparse-dev xorg-dev ccache -y

Windows

For contributors using Windows, we also have a setup process to ensure you can compile and test changes locally. Here's how to set up your development environment on Windows:

  1. Install Miniconda: We use Miniconda to manage dependencies. Install it from here.

  2. Setup Miniconda and Install Dependencies:

    conda install -c conda-forge mpir -y

  3. Configure Environment Variables: Set the required environment variables for the build. This assumes PowerShell.

    $Env:GMP_INC = "C:\Miniconda\Library\include"
$Env:GMP_LIB = "C:\Miniconda\Library\lib"

    Note: You may need to adjust these paths depending on if you use a non-global conda environment.

Installation

To install the library in editable mode:

  1. Clone the repository:

    git clone https://github.com/pyvista/pytetwild

  2. Initialize submodules:

    git submodule update --init --recursive

  3. Install the project in editable mode and include development dependencies:

    pip install -e .[dev]

    Note: On windows, you'll need to copy the mpir.dll to your source directory with:

    python -c "import shutil, os; shutil.copy(os.path.join(os.getenv('GMP_LIB'), '..', 'bin', 'mpir.dll'), './src/pytetwild')"

Code Style and Quality

  • Documentation: Follow the numpydoc style for docstrings.
  • Linting: We use ruff for code styling to ensure consistency.
  • Pre-commit: Utilize pre-commit hooks to automate checks before commits. Set up your local environment with: 
    pip install pre-commit
pre-commit install
  • Testing: Write tests for new features or bug fixes and run them using pytest. Tests are located in the tests directory.

How to Contribute

  • Bugs and Feature Requests: Submit them through our issues page.
  • Code Contributions: Make changes in a fork of this repository and submit a pull request (PR) through our PR page. Follow the standard fork-and-PR workflow for contributions.

Community and Conduct

  • We expect all contributors to follow our Code of Conduct to maintain a welcoming and inclusive community.

License

  • Contributions are subject to the project's license as found in the LICENSE.md file.

We welcome your contributions and look forward to collaborating with you!