METRICS

Project information

• This was the codebase I developed during a fun undergrad research experience at Bagheri Lab.
• See project design here
• See documentation here

Getting started

1. Clone the repo.

2. Activate the environment.

$ poetry shell

3. Install dependencies.

$ poetry install

4. Run the CLI.

$ python3 src/main.py

Setup Information

This repository is uses the following tools:

• Poetry for packaging and dependency management
• Tox for automated testing
• Black for code formatting
• Pylint for linting

as well as GitHub Actions to automatically build, test, lint, and generate documentation.

General commands

The Makefile include three commands for working with the project.

• make clean will clean all the build and testing files
• make build will run tests and lint your code (you can also just run tox)
• make docs will generate documentation