Getting Started

Install Python

If you don’t have Python environment, please install python from 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 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.2.zip

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

$ pip install jaxa-earth-0.1.2.zip

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

  • matplotlib

  • requests

If you finish installing, launch python.

$ python

Check the API was correctly installed by executing following script in python.

from jaxa.earth import je

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

Without install

First, download the API package from below.

jaxa-earth-0.1.2.zip

Next, unzip the package. start command prompt and change directory to the package’s folder location.

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

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 can correctly use the API module. 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.2” 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.2")