Skip to content

Installing hip-analysis

This guide covers different methods to install hip-analysis for your analytical work.

We recommend installing hip-analysis using pixi with the custom conda channel wfp-ram. This ensures you get the most up-to-date version with all dependencies properly resolved.

Prerequisites

  1. Install pixi by following the instructions at https://pixi.sh/latest/

Installation Steps

If you have an existing pixi project, simply add hip-analysis:

pixi add --channel wfp-ram hip-analysis

Starting from scratch? Initialize a new pixi project first:

pixi init your-analysis-project
cd your-analysis-project
pixi add --channel wfp-ram hip-analysis

Verify Installation

pixi run python -c "import hip.analysis; print(hip.analysis.__version__)"

Alternative Installation (Conda/Mamba)

If you prefer using conda or mamba directly:

Using Conda

# Add the wfp-ram channel
conda config --add channels wfp-ram

# Install hip-analysis
conda install hip-analysis

Using Mamba

# Add the wfp-ram channel  
mamba config --add channels wfp-ram

# Install hip-analysis
mamba install hip-analysis

Installation Notes

  • Pip installation is not recommended as it may not resolve all geospatial dependencies correctly
  • The wfp-ram channel contains optimized builds specifically for humanitarian analysis workflows
  • For development work, see the contributing guide in the repository README

Troubleshooting

If you encounter installation issues:

  1. Ensure you have added the wfp-ram channel before installation
  2. Try creating a fresh environment to avoid dependency conflicts
  3. For pixi users, try pixi clean followed by pixi install

Next Steps

Once installed, check out the quick start tutorial to begin analyzing spatiotemporal data with hip-analysis.

You may also need to set up credentials for accessing certain data sources.