README.md

queueUI

Table of Contents

• queueUI
  • Table of Contents
  • Usage
  • Installation
  • Contributing
  • Acknowledgments
  • License

Installation

On a terminal:

git clone https://github.com/BCDA-APS/queueUI.git
cd queueUI
conda env create --force -n queueUI -f ./env.yml
conda activate queueUI
pip install -e . --no-deps

Usage

On a terminal:

conda activate queueUI
queueUI &

Using Pre-commit

• To run pre-commit checks before committing, run pre-commit run --all-files
• NONE OF THE FOLLOWING SHOULD BE DONE REGULARLY, AND ALL CHECKS SHOULD BE PASSING BEFORE BRANCHES ARE MERGED
  • To skip linting during commits, use SKIP=ruff git commit ...
  • To skip formatting during commits, use SKIP=ruff-format git commit ...
  • To skip all pre-commit hooks, use git commit --no-verify ...
• See pre-commit documentation for more

Contributing

Please report bugs, enhancement requests, or questions through the Issue Tracker.

If you are looking to contribute, please see CONTRIBUTING.md.

Citing

License

queueUI is MIT licensed, as seen in the LICENSE file.