Skip to main content

Tools for converting Unified Forecast System (UFS) output to Analysis Ready, Cloud Optimized (ARCO) format

Project description

ufs2arco

Conda version PyPI version OS Support Python Documentation Status

ufs2arco is a python package that is designed to make NOAA forecast, reanalysis, and reforecast datasets more accessible for scientific analysis and machine learning model development. The name stems from its original intent, which was to transform output from the Unified Forecast System (UFS) into Analysis Ready, Cloud Optimized (ARCO; Abernathey et al., (2021)) format. However, the package now pulls data from a number of non-UFS sources, including GFS/GEFS before UFS was created, and even ECMWF's ERA5 dataset.

To learn how to use ufs2arco, check out the documentation here

Installation

Recommended: Install from conda-forge

Given that some ufs2arco dependencies are only available on conda-forge, it's recommended that users install using this method

conda install -c conda-forge ufs2arco

This will install all underlying dependencies, including mpi4py which by default installs mpich for MPI support. If a different MPI distribution is desired, for example Intel MPI, then this can be installed via:

conda install -c conda-forge ufs2arco impi_rt

in the exact same way as directed in this section of the mpi4py documentation.

Install from conda-forge without MPI

If you do not want to install MPI through conda-forge, for instance if you want to use an MPI distribution that is already built on a system you're using, then it is recommended to install the nompi build from conda-forge as follows:

conda install -c conda-forge ufs2arco=*=nompi*

Then, one can install mpi4py from pip using these instructions, or following instructions specific to your machine.

Install from pip

It is possible to install ufs2arco from pypi via:

pip install ufs2arco

However, this will not come with the MPI or xesmf dependencies, since these need to be installed from conda-forge.

Get in touch

Report bugs, suggest features, or view the source code on GitHub.

License and Copyright

ufs2arco is licensed under the Apache-2.0 License.

Development occurs on GitHub at https://github.com/NOAA-PSL/ufs2arco.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ufs2arco-0.19.0.tar.gz (6.7 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ufs2arco-0.19.0-py3-none-any.whl (88.9 kB view details)

Uploaded Python 3

File details

Details for the file ufs2arco-0.19.0.tar.gz.

File metadata

  • Download URL: ufs2arco-0.19.0.tar.gz
  • Upload date:
  • Size: 6.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for ufs2arco-0.19.0.tar.gz
Algorithm Hash digest
SHA256 f082edafaf873534c3d17d4a90897b130baee5d9ec2b1137c6ba8c5dd6545878
MD5 8c54523df23d590ed8e47e1a66c49188
BLAKE2b-256 02caeb588f0842a8ed1e3eaab499adde3a697aeb1ade4ad09cfabe833a3f17be

See more details on using hashes here.

Provenance

The following attestation bundles were made for ufs2arco-0.19.0.tar.gz:

Publisher: publish.yaml on NOAA-PSL/ufs2arco

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ufs2arco-0.19.0-py3-none-any.whl.

File metadata

  • Download URL: ufs2arco-0.19.0-py3-none-any.whl
  • Upload date:
  • Size: 88.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for ufs2arco-0.19.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5218d32c94ae8a5bd91cf40769b9608fb6c55ac5ac602004ee83880f57d09de2
MD5 480feaf6dfc2b59fb19b7aff70e67c84
BLAKE2b-256 b1593d04691c0ba6d158b9e294315cd46ab1e3a4a6e59ed0f4954619c7a33f31

See more details on using hashes here.

Provenance

The following attestation bundles were made for ufs2arco-0.19.0-py3-none-any.whl:

Publisher: publish.yaml on NOAA-PSL/ufs2arco

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page