Getting Started

Install Python

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

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

First, download the API package from below.

jaxa-earth-0.1.4.zip

Next, change directory to path of the files, and command pip:

$ pip install jaxa-earth-0.1.4.zip

Module packages and dependent packages below that the API depends on are also installed.

  • matplotlib

  • requests

When you finish installing, launch python.

$ python

Check the API is installed correctly by executing following script in Python.

from jaxa.earth import je

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

Without install

First, download the API package from below.

jaxa-earth-0.1.4.zip

Next, unzip the package. Start command prompt and change directory to folder location for the package.

$ cd C://YOUR-FOLDER-PATH/jaxa-earth-0.1.4

It is necessary to install module packages and dependent packages below that the API depends on.

  • matplotlib

  • requests

Next, launch python.

$ python

Next, execute the script in python

from jaxa.earth import je

If no error occurs, you are able to use the API module correctly. To use the module in different directly, please add the following script to your Python scripts. It’s necessary to modify “C://YOUR-FOLDER-PATH/jaxa-earth-0.1.4” to your environment’s JAXA Earth API for Python’s absolute folder path.

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