lincc-frameworks-mask-incubator / corrgi

Fast 2-point correlation estimation with LSDB and gundam
BSD 3-Clause "New" or "Revised" License
2 stars 1 forks source link

corrgi

Template

PyPI GitHub Workflow Status Codecov Benchmarks

This project provides glue code between LSDB and gundam to perform fast calculation of 2-point correlation functions.

Dev Guide - Getting Started

Before installing any dependencies or writing code, it's a great idea to create a virtual environment. LINCC-Frameworks engineers primarily use conda to manage virtual environments. If you have conda installed locally, you can run the following to create and activate a new environment.

>> conda create env -n <env_name> python=3.10
>> conda activate <env_name>

Once you have created a new environment, you can install this project for local development using the following commands:

>> pip install -e .'[dev]'
>> pre-commit install