Skip to content

Installation

MagGeo requires Python 3.8 or higher and can be installed via pip or from source.

Requirements

  • Python: 3.8 or higher
  • Operating System: Windows, macOS, or Linux
  • VirES Token: Required for downloading Swarm data (free registration)
pip install maggeo

For development features:

pip install "maggeo[dev]"

For documentation building:

pip install "maggeo[docs]"

Install from Source

For the latest development version:

git clone https://github.com/fbenitez92/maggeo.git
cd maggeo
pip install -e ".[dev]"

Get Your VirES Token

Token Required

You need a VirES token to download Swarm satellite data.

  1. Go to VirES for Swarm
  2. Click "Sign up" and create a free account
  3. After login, go to your profile to find your access token
  4. Copy the token for use in MagGeo

Verify Installation

Test your installation:

import maggeo
print(f"MagGeo version: {maggeo.__version__}")

# Test basic functionality
from maggeo import SwarmDataManager
manager = SwarmDataManager("test_data")
print("✅ MagGeo installed successfully!")

Troubleshooting

Common Issues

ImportError: No module named 'maggeo'

Solution: Make sure you activated the correct Python environment where MagGeo is installed.

Token authentication failed

Solution: Check that your VirES token is correct and your account is active.

Permission denied when writing files

Solution: Ensure you have write permissions to your data directory.