Repository navigation
2. Installation
The Installation section provides users with instructions on setting up the repository environment, installing dependencies and configuring the repository for their specific needs.
Conda is a package management system and environment management system that simplifies the installation and management of software packages and dependencies. It allows users to create isolated environments with specific versions of packages, ensuring reproducibility and compatibility across different projects.
We recommend using Miniforge as the Conda distribution.
- Download and install Miniforge from the official repository following the latest installation instructions provided.
- Download the EOAF repository to your local machine using Git or by downloading the ZIP file from the GitHub repository page.
- Navigate to the downloaded repository directory and create a Conda environment using the provided environment.yml file by running the following command in your terminal to create a new Conda environment named EoAF:
conda env create -f environment.yml - Activate the newly created Conda environment, allowing you to work within the isolated environment by running the following command in your terminal:
conda activate EoAF
Poetry is a dependency management and packaging tool for Python that simplifies the management of project dependencies, packaging, and distribution. It provides a declarative approach to dependency management and ensures reproducibility and consistency across different environments.
- Install the required dependencies by running the following command in your terminal:
poetry install --no-root
The config.yaml file located in the repository's root directory contains configuration settings such as directory paths.
Confirm the download and processed directory paths for each satellite provider within the config.yaml file and update them as required. By default, the data will be saved in the data directory located within the repository's working directory.