{"repo":"gboeing/project-template","free":true,"listed":false,"github":"https://github.com/gboeing/project-template","clone":"git clone https://github.com/gboeing/project-template.git","description":"Template for rapidly starting new projects that include data, code, and a LaTeX paper.","language":"TeX","stars":13,"topics":["latex","latex-document","latex-template","publication","research","research-paper","research-project","research-tool","template","templates"],"license":"MIT","category":"saas-starters-boilerplates","readme_excerpt":"Research project template This is a template for rapidly starting new projects that include data, code, and a LaTeX paper. Setup 1. Install uv and git if you haven't already. 2. Git clone this repository to your computer. 3. Open a terminal and change directories to the repository's root. 4. Run uv sync to set up the local virtual environment. 5. Run uv run prek install to install the pre-commit hooks. 6. Run uv run jupyter lab if you wish to run JupyterLab. Contributing guidelines Project organization Code : keep all code in the code folder. Code should be type-annotated, use numpy-style docstrings, and pass all pre-commit hooks. Prefer .py Python scripts to .ipynb IPython notebooks whenever possible. Data : keep all data outside of this repo (such as a shared Google Drive) and provide direct links (accessible only to people explicitly granted access) in the readme file at data/README.md . Paper : keep the paper in the paper folder and follow the guidelines there. Dependencies : ensure every (non-standard library) package imported anywhere in the code is added to the pyproject.toml dependencies. Pin each dependency to its minor version. Workflow and quality control Work in branches and open pull requests to propose merging your code changes into main. Whenever you do work, first git pull the latest changes to your local computer. Commit code changes frequently, and push at the end of every day you do work. If you didn't push code to Github, you didn't work on code that day. ","default_branch":null,"files":null,"tree":[],"storefront":"/r/gboeing","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/gboeing/project-template/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}