Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a README #313

Merged
merged 11 commits into from
Jul 16, 2021
56 changes: 56 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@

# fv3atm

This is the [NOAA Environmental Modeling
Center](https://www.emc.ncep.noaa.gov/emc_new.php) version of the FV3
atmospheric model dynamical core, originally from the [Geophysical
Fluid Dynamics Laboratory](https://www.gfdl.noaa.gov/).

The fv3atm is part of NOAA's [Unified Forecast System
(UFS)](https://ufscommunity.org/).

## Prerequisites

This package requires the following
- [NCEPLIBS](https://github.com/NOAA-EMC/NCEPLIBS) packages:
- [NCEPLIBS-w3nco](https://github.com/NOAA-EMC/NCEPLIBS-w3nco)
- [NCEPLIBS-bacio](https://github.com/NOAA-EMC/NCEPLIBS-bacio)
- [NCEPLIBS-nemsio](https://github.com/NOAA-EMC/NCEPLIBS-nemsio)
- [NCEPLIBS-sp](https://github.com/NOAA-EMC/NCEPLIBS-sp)

This package also requires the following packages:
- [netcdf-c Library](https://github.com/Unidata/netcdf-c)
- [netcdf-fortran Library](https://github.com/Unidata/netcdf-fortran)
- [ESMF](https://github.com/esmf-org/esmf)
- [GFDL's Flexible Modeling System](https://github.com/NOAA-GFDL/FMS)
- [Jasper](https://github.com/jasper-software/jasper)

## Building and Installing

```
mkdir build
cd build
cmake -DCMAKE_INSTALL_PREFIX=/path/to/install ..
make -j2
make install
```

## References

## Disclaimer

The United States Department of Commerce (DOC) GitHub project code is
provided on an "as is" basis and the user assumes responsibility for
its use. DOC has relinquished control of the information and no longer
has responsibility to protect the integrity, confidentiality, or
availability of the information. Any claims against the Department of
Commerce stemming from the use of its GitHub project will be governed
by all applicable Federal law. Any reference to specific commercial
products, processes, or services by service mark, trademark,
manufacturer, or otherwise, does not constitute or imply their
endorsement, recommendation or favoring by the Department of
Commerce. The Department of Commerce seal and logo, or the seal and
logo of a DOC bureau, shall not be used in any manner to imply
endorsement of any commercial product or activity by DOC or the United
States Government.