Skip to content

Getting Started

Install Python

If you don't have a Python environment, install Python from the official site. The API was generated and checked in Python 3.8.10 and above.

https://www.python.org/

Install QGIS (optional)

If you would like to use the API in QGIS, install QGIS from the official site. The API was checked in QGIS 3.10.6.

https://qgis.org/

How to use JAXA Earth API for Python

With install

Case 1: Install via PyPI (recommended)

pip install jaxa-earth

Case 2: Download and install

Download the package and install:

jaxa-earth-0.1.6.zip

pip install jaxa-earth-0.1.6.zip

Module packages and dependent packages the API depends on are also installed:

  • matplotlib
  • requests

Verify installation

Launch Python and check the API is installed correctly:

from jaxa.earth import je

If no error occurs, you have installed the API module correctly.

Without install

Unzip the package and add the path to your Python scripts:

import sys
sys.path.append("C://YOUR-FOLDER-PATH/jaxa-earth-0.1.6")
from jaxa.earth import je

Minimal usage example

from jaxa.earth import je

# Get an image using all default parameters
data = je.ImageCollection(ssl_verify=True) \
         .filter_date() \
         .filter_resolution() \
         .filter_bounds() \
         .select() \
         .get_images()

# Show the image
img = je.ImageProcess(data) \
        .show_images()

Note

If you encounter an SSL error, set ssl_verify=False.