Skip to content

aragong/metoceanproviders

Repository files navigation

Met-ocean providers

GitHub top language GitHub tag (latest by date) GitHub repo size GitHub Code style: black pre-commit Coverage

Python package to access main open-access met-ocean products (Forecast, Reanalysis and other type of atmospheric and oceaninc databases) from general providers (CMEMS, NOAA...)


🏠 Installation

pip install git+ssh://git@github.com/aragong/metoceanproviders.git@v0.2.0

✔️ Run tests

# Declare a ".env" file with "CMEMS_USERNAME" and "CMEMS_PASSWORD" variables is needed. 
# You can do it directly using dotenv cli commands in bash or create the file manually:
dotenv set CMEMS_USERNAME your_cmems_username
dotenv set CMEMS_PASSWORD your_cmems_password

⚡ Get Started

import metoceanproviders

dataset_id = "cmems_dataset_string_id"
username = "your_cmems_username"
password = "your_cmems_password"

# EXAMPLE for accessing CMEMS opendap products
data = metoceanproviders.CmemsOpendap(dataset_id, username, password)

# To visualize connected xarray dataset.
data.ds 

# To crop dataset.
data.crop(varaibles, times, longitudes, latitudes) 

# To download to NetCDF-file (daily files if the size not allowwed by the server)
data.to_netcdf(output_path)

♻️ Continuous integration (CI)

  • Pre-commit with black formatter hook on commit. (.pre-commit-config.yaml)
  • Github workflow with conda based deployment and testing on tag. (Github action)
  • Test and update coverage badge manually through vscode task: run test and coverage

📨 Contact us

🐍 For code-development issues contact 👨‍💻 German Aragon @ 🏢 IHCantabria

©️ Credits

Developed by 👨‍💻 German Aragon @ 🏢 IHCantabria.

About

Access to general MetOcean providers/products

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages