data

How to load seed data

• 1. Run the seed data importer natively
  • 1.1. System requirements
  • 1.2. Configure environment variables
  • 1.3. Download dependencies
  • 1.4. Execute the process
• 2. Run the seed data importer in a Docker container
• Documentation References to update/review

---

TODO: Improve the documentation of the whole process to understand what is doing at a high level.

To load seed data for the API, you can use the included Makefile. There are two ways to execute it:

1. Run the seed data importer natively

TODO: Add some diagrams that explain at a high level the sequence and flow of execution of all the data transformation.

1.1. System requirements

• Python
• Docker

1.2. Configure environment variables

TODO: Explain:

• what environment variables
• templates with default values suitable for local development
• where to get values for environment variables with "real" credentials for external services (Geocoding, email, ...)
• explain where the real credentials are stored per environment (staging, production, ...)

1.3. Download dependencies

TODO: Install the python dependencies (replace the usage of pip and requirements.txt with uv and pyproject.toml)

1.4. Execute the process

make seed-data

Note: You need to manually set up dependencies such as python packages (see requirements.txt) and other system dependencies (see Dockerfile). Additionally, you must manually set several environment variables to connect to the PostgreSQL database that will host the data.

2. Run the seed data importer in a Docker container

./data.sh seed-data

Note: Ensure you have Docker and Docker Compose properly set up. Application dependencies will be automatically installed, and environment variables will be loaded from the .env file at the root of the project. Refer to the env.default file for an example of the required .env file.

Choose the method that best fits your setup and follow the instructions accordingly.

Documentation References to update/review

• base_data_importer/README.md
• data/: (TODO: no documentation)
• gadm_importer/README.md
• h3_data_importer/README.md
• indicator_coefficient_importer/: (TODO: no documentation)
• notebooks/: (TODO: no documentation)
• preprocessing/README.md
• test/: (TODO: no documentation)

---

↩️ GO TO ROOT DOC