Skip to content

Installation & Setup

Getting your Copernicus credentials and setting up vresto.

Prerequisites

Step 1: Get Your Credentials

You need credentials to access Copernicus satellite data.

Copernicus Username & Password

  1. Visit Copernicus Dataspace
  2. Create an account or sign in
  3. Save your email and password

For better performance and higher quotas, generate static S3 credentials:

  1. Log in to Copernicus Dataspace
  2. Navigate to your account settings
  3. Follow the official guide: S3 Registration
  4. Create your S3 credentials (access key + secret key)

⚠️ Important: If you skip this step, vresto will auto-generate temporary S3 credentials with strict usage limits. These temporary credentials have limited quotas and will be exhausted quickly if you perform large downloads. To avoid hitting quota restrictions, it's highly recommended to request your own permanent S3 credentials from Copernicus Dataspace (see link above).

Step 2: Configure Environment

Choose one method:

Option A: Web Interface (Easiest for S3 Credentials)

Once you've started the web interface:

  1. Set your Copernicus credentials in environment variables or .env file (at least COPERNICUS_USERNAME and COPERNICUS_PASSWORD are needed for search functionality)
  2. Launch the app with make app or python src/vresto/ui/app.py
  3. Open http://localhost:8610 in your browser
  4. Click the menu button (≡) in the top-left corner to open the settings drawer
  5. Scroll to the S3 Credentials section
  6. Enter your S3 Access Key ID and S3 Secret Key
  7. Click Save Credentials

The credentials are saved to your .env file and used immediately. This is convenient if you want to add S3 credentials after initial setup without editing files manually.

export COPERNICUS_USERNAME="your_email@example.com"
export COPERNICUS_PASSWORD="your_password"
export COPERNICUS_S3_ACCESS_KEY="your_access_key"      # Optional
export COPERNICUS_S3_SECRET_KEY="your_secret_key"      # Optional

To make permanent, add to ~/.zshrc:

echo 'export COPERNICUS_USERNAME="your_email@example.com"' >> ~/.zshrc
source ~/.zshrc

Option C: .env File

Create .env in your project root:

COPERNICUS_USERNAME=your_email@example.com
COPERNICUS_PASSWORD=your_password
COPERNICUS_S3_ACCESS_KEY=your_access_key
COPERNICUS_S3_SECRET_KEY=your_secret_key

vresto automatically loads this file on startup.

Step 3: Install vresto

From PyPI

pip install vresto
# or with uv
uv pip install vresto

From Source

git clone https://github.com/kalfasyan/vresto.git
cd vresto
uv sync

Troubleshooting

"Credentials not configured" Error

Make sure your credentials are set in environment variables or .env file:

env | grep COPERNICUS

You should see COPERNICUS_USERNAME and COPERNICUS_PASSWORD.

"Max number of credentials reached" Error

This means temporary S3 credentials are exhausted. Solution: Add static S3 keys to your environment (see Step 2).

API Connection Issues

  • Verify your credentials are correct on Copernicus Dataspace
  • Check your internet connection
  • Try accessing the S3 endpoint directly: https://eodata.dataspace.copernicus.eu

Next Steps