Skip to content
This repository has been archived by the owner on Aug 13, 2024. It is now read-only.

VasuLab/KnightShock

Repository files navigation

KnightShock

CI codecov license Code style: black

Overview

Warning

KnightShock is currently in alpha; therefore, its interface is not guaranteed to be stable.

KnightShock is a shock tube experiment planning and data analysis Python package developed at Vasu Lab at the University of Central Florida.

Installation

Note KnightShock requires Python 3.10 or higher.

KnightShock can be cloned with the following command:

git clone https://github.com/VasuLab/KnightShock

Contributing

For any bugs or feature requests, create an issue on the issue tracker.

After cloning the repository, the development environment can be set up with

pip install -r requirements.txt

Before creating a pull request, be sure to lint

black .

and run the automated tests

pytest

These checks will be performed automatically for all pull requests along with test coverage comparisons.