---

Title of The Project/Research

💬 Description

[ADD A CONCISE DESCRIPTION AND INTRODUCTION TO YOUR PROJECT (PREFERABLY WITH SOME TABLES AND FIGURES)]

🛠️ Developer Setup

Please refer to the file requirements.txt for a comprehensive list of packages and their corresponding version.

1. Clone and install dependencies

git clone https://github.com/yourusername/project_template.git
cd project_template
python -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
pip install -r requirements.txt

2. Setup the project

Option A: Using Makefile (Recommended)

Fast, easy, automated setup.

make dev
make format
make test
make docs
make clean

Option B: Manually setting up

B.1. Enable pre-commit hooks

Optional but recommended for code quality assurance. If you fail to do, the GitHub Actions CI/CD pipeline will catch the issues; so better to catch them yourself before pushing changes.

pre-commit install
pre-commit run --all-files  # optional, to format everything once
pre-commit autoupdate  # Run this periodically to keep hooks updated

B.2. Enable pre-commit hooks

pytest

B.3. Build the documentation

cd docs
make html

🏗️ Directory/Folder Structure

project_template
├── data
├── dbs
├── docs
│   ├── api
│   ├── diagrams
│   ├── experiments
│   ├── notes
│   ├── reports
│   └── tutorials
├── images
│   └── logos
├── logs
│   ├── deploy
│   ├── dev
│   └── maintain
├── models
│   ├── checkpoints
│   ├── configs
│   ├── final
│   └── history
├── outputs
│   ├── inferences
│   └── training
├── project_files
├── src
│   └── project_name
└── tests

28 directories

Citation

@article{<bib_key>,
  author = {<Author1_surname, Author1_name> and <Author2_surname, Author2_name>},
  title = {<Title>},
  year = {<Year>},
  publisher = {<Publisher>},
  journal = {<Journal_Name>},
  url = {<URL>},
  doi = {<DOI>},
  month = {<Published_Month>},
  keywords = {<Keyword1>, <Keyword2>, <Keyword3>, <Keyword4>, <Keyword5>}
}

📬 Contact

Should you have any questions, feel free to contact @tekboart.

⚖️ License

This repository has a GPL-3.0 license license, as found in the LICENSE file.