search

scexao-org / vampires_dpp

Tools for processing VAMPIRES data
MIT License
3 stars 3 forks source link

readme

VAMPIRES Data Processing Pipeline

CI tests Docs Coverage License

vampires_dpp is still under development, and the API can change without notice. Use with your own caution (and please report any bugs you find).

Primary maintainer: Miles Lucas

(Experimental) Tools for processing VAMPIRES data

WARNING: version 0.13.0 has breaking changes that have not been fully documented! Contact Miles for more details.

Installation

For now, install directly from GitHub

pip install git+https://github.com/scexao-org/vampires_dpp#egg=vampires_dpp

otherwise clone this repository and install locally

git clone https://github.com/scexao-org/vampires_dpp
pip install vampires_dpp

Citing

If you use vampires_dpp in your research, please consider citing it as software with the following DOI: TODO

License

vampires_dpp is licensed under the MIT open-source license. See LICENSE for more details.

Contributing and Support

If you would like to contribute, feel free to open a pull request. If you want to discuss something before contributing, head over to discussions and join or open a new topic. If you're having problems with something, please open an issue.