Install requirements

This project uses uv for requirements.

uv sync

How to get data

TODO document how to get the data

How to run

This project uses just

just --list

Project Organization

Note this project uses

Justfile: Command runner with commands like just data or just train
data: data directory
- ./10_raw <- The original, immutable data dump.
- ./20_interim <- Intermediate data that has been transformed.
- ./30_processed <- The final, canonical data sets for modeling.
nbs: Jupyter notebooks. Name with creator's initials, a number (for ordering), and short - delimited description, e.g. jqp-1.0-initial-data-exploration.
pyproject.toml: defines poetry project dependencies and build configuration
{{cookiecutter.project_name}}: Source code for use in this project.

If you used this work, please aknowledge it by citing this repository

@software{wassname2024{{ cookiecutter.project_name.lower().replace(' ', '_') }},
  author = {Clark, M.J.},
  title = { {{cookiecutter.project_name}} },
  year = {2024},
  publisher = {GitHub},
  journal = {GitHub repository},
  url = {https://github.com/wassname/{{ cookiecutter.project_name.lower().replace(' ', '_') }} },
  commit = {<commit hash>}
}

Project based on the cookiecutter data science project template. #cookiecutterdatascience