ollin18 / informality

Research on differences in mobility for people working in informality

repo-informalidad

Get started!

In order to start a new empty project you would first need to have cookiecutter installed in your python environment and then run:

cookiecutter https://github.com/ollin18/ds-project-template --directory="python"

cookiecutter gh:/teatauri/cookiecutter-for-scientists --directory="julia"

Tools used in this project

• Poetry: Dependency management - article
• hydra: Manage configuration files - article
• pre-commit plugins: Automate code reviewing formatting
• DVC: Data version control - article
• pdoc: Automatically create an API documentation for your project

Set up the environment

1. Install Poetry
2. Set up the environment:

make env

Install dependencies

To install all dependencies for this project, run:

poetry install

To install a new package, run:

poetry add <package-name>

Version your data

To track changes to the "data" directory, type:

dvc add data

This command will create the "data.dvc" file, which contains a unique identifier and the location of the data directory in the file system.

To keep track of the data associated with a particular version, commit the "data.dvc" file to Git:

git add data.dvc
git commit -m "add data"

To push the data to remote storage, type:

dvc push

Auto-generate API documentation

To auto-generate API document for your project, run:

make docs