This guide covers the necessary steps to configure your environment for the ClimatesetExtension project.
This project is configured to use Miniforge or Micromamba for environment isolation and non-Python dependencies, while using Poetry as the primary build tool for managing Python packages. You can choose which one to install using the make conda-install command.
The project is configured to use the mamba tool instead of conda or micromamba. See Makefile.private.example if you require something other than mamba locally.
The project relies on a Makefile to automate common tasks, including environment management, package installation, linting, testing, and documentation generation.
For a comprehensive list of targets and detailed explanations of the Makefile structure, please consult the Makefile Documentation.
You can discover all available commands and view your current project configuration directly in your terminal:
# List all available Makefile targets
make targets
# View current project configuration (Python version, active target groups, etc.)
make infoFollow these steps to initialize the environment using the configured Conda and Poetry toolchain.
- Create the Conda environment:
This step handles non-Python dependencies and isolates the environment.
make conda-create-env
- Activate the environment:
eval $(make conda-activate)
- Install the Python package and development tools via Poetry:
This target will automatically verify Poetry is available and use it to install the package dependencies.
make install
Weights and Biases (WandB) is the planned solution for experiment tracking, as it is natively accessible on MILA and DRAC clusters.
- Configurations: Review the configs/ directory for YAML configurations.
- Contributing: Refer to the Contribution Guidelines for repository standards.