Unofficial python client for G-Portal Catalogue Service and SFTP.
This package is distributed under the MIT License, but the data that can be retrieved through this package is provided under G-Portal Terms of Use. Please make sure to review them before using the G-Portal data.
$ pip install gportal
import gportal
# Get the dictionary of the G-Portal dataset.
# It corresponds to the "spacecraft/sensor" search tree of the Web UI.
datasets = gportal.datasets()
# Build a search query.
res = gportal.search(
dataset_ids=datasets["GCOM-C/SGLI"]["LEVEL2"]["Land area"]["L2-LST"],
start_time="2023-03-25T00:00:00",
end_time="2023-03-25T23:59:59",
bbox=[130, 30, 140, 40],
params={
# You can add more parameters.
# See Appendix 7 of G-Portal User's Manual for more details:
# https://gportal.jaxa.jp/gpr/assets/mng_upload/COMMON/upload/GPortalUserManual_en.pdf
},
)
print("Matched:", res.matched())
# Get the resulting products.
products = res.products()
# Download the product files via SFTP.
gportal.username = "sankichi92"
gportal.password = "**********" # If env var GPORTAL_PASSWORD is set, the value is used.
gportal.download(products, local_dir="path/to/download/dir")
https://gportal.readthedocs.io/
Bug reports and pull requests are welcome on GitHub at https://github.com/sankichi92/gportal-python. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.
This project uses Poetry.
$ poetry install
$ poetry run pytest
$ poetry run mkdocs serve
- Bump the version in
pyproject.toml
bypoetry version
and commit it. - Create a git tag for the new version.
- Push it to GitHub, and then the
publish-package
workflow starts.