Skip to content

euroargodev/argopy

Repository files navigation

argopy logo
argopy is a python library dedicated to Argo data access, visualisation and manipulation for regular users as well as Argo experts and operators
DOI Documentation Pypi Conda
codecov CI CI Energy
Open-SSF

Documentation

The official documentation is hosted on ReadTheDocs.org: https://argopy.readthedocs.io

Install

Binary installers for the latest released version are available at the Python Package Index (PyPI) and on Conda.

# conda
conda install -c conda-forge argopy
# or PyPI
pip install argopy

argopy is continuously tested to work under most OS (Linux, Mac, Windows) and with python versions >= 3.8

Usage

# Import the main data fetcher:
from argopy import DataFetcher
# Define what you want to fetch... 
# a region:
ArgoSet = DataFetcher().region([-85,-45,10.,20.,0,10.])
# floats:
ArgoSet = DataFetcher().float([6902746, 6902747, 6902757, 6902766])
# or specific profiles:
ArgoSet = DataFetcher().profile(6902746, 34)
# then fetch and get data as xarray datasets:
ds = ArgoSet.load().data
# or
ds = ArgoSet.to_xarray()
# you can even plot some information:
ArgoSet.plot('trajectory')    

They are many more usages and fine-tuning to allow you to access and manipulate Argo data:

Just check out the documentation for more !

🌿 Energy impact of argopy development

The argopy team is concerned about the environmental impact of your favorite software development. Starting June 1st 2024, we're experimenting with the Green Metrics Tools from Green Coding to get an estimate of the energy used and CO2eq emitted by our development activities on Github infrastructure. Results:

Activity Green Coding tool
All Dashboard
CI tests running on each commit CI Energy
Upstream CI tests, running daily CI Energy

Development and contributions

See our development roadmap here: https://github.com/euroargodev/argopy/milestone/3

Checkout the contribution page if you want to get involved and help maintain or develop argopy.