Tools for converting Unified Forecast System (UFS) output to Analysis Ready, Cloud Optimized (ARCO) format
Project description
ufs2arco
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ufs2arco-0.18.0.tar.gz.
File metadata
- Download URL: ufs2arco-0.18.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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
59e34b1b39bbce698d66ede656fc6c3be6542973da6963154f8bba6871c2afec
|
|
| MD5 |
8e69fb7b6c638b7514464d1e3bfd621a
|
|
| BLAKE2b-256 |
49ed7e2970826a222029304c56c8e094b53fafa6dae26c80f83367aa200b2958
|
Provenance
The following attestation bundles were made for ufs2arco-0.18.0.tar.gz:
Publisher:
publish.yaml on NOAA-PSL/ufs2arco
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
ufs2arco-0.18.0.tar.gz -
Subject digest:
59e34b1b39bbce698d66ede656fc6c3be6542973da6963154f8bba6871c2afec - Sigstore transparency entry: 760537947
- Sigstore integration time:
-
Permalink:
NOAA-PSL/ufs2arco@cb97ebec84e745b4a246e38fc0ff20f77f2641a4 -
Branch / Tag:
refs/tags/v0.18.0 - Owner: https://github.com/NOAA-PSL
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yaml@cb97ebec84e745b4a246e38fc0ff20f77f2641a4 -
Trigger Event:
release
-
Statement type:
File details
Details for the file ufs2arco-0.18.0-py3-none-any.whl.
File metadata
- Download URL: ufs2arco-0.18.0-py3-none-any.whl
- Upload date:
- Size: 87.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f1be55fbe92a1a03501dcba4d7b377e7ca3f973236990e0db3434ca8079549bd
|
|
| MD5 |
3c859f701f2b2e16a456b9006bcec6ba
|
|
| BLAKE2b-256 |
acf5010e1f93fb414a3806ee26466beff58be8b056999270f852629792ace297
|
Provenance
The following attestation bundles were made for ufs2arco-0.18.0-py3-none-any.whl:
Publisher:
publish.yaml on NOAA-PSL/ufs2arco
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
ufs2arco-0.18.0-py3-none-any.whl -
Subject digest:
f1be55fbe92a1a03501dcba4d7b377e7ca3f973236990e0db3434ca8079549bd - Sigstore transparency entry: 760537951
- Sigstore integration time:
-
Permalink:
NOAA-PSL/ufs2arco@cb97ebec84e745b4a246e38fc0ff20f77f2641a4 -
Branch / Tag:
refs/tags/v0.18.0 - Owner: https://github.com/NOAA-PSL
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yaml@cb97ebec84e745b4a246e38fc0ff20f77f2641a4 -
Trigger Event:
release
-
Statement type: