Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexanderRichert-NOAA committed Nov 7, 2023
1 parent 0dbb01f commit 7bba531
Showing 1 changed file with 26 additions and 24 deletions.
50 changes: 26 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@

# Interpolation Library

The NCEP general interpolation library contains Fortran 90
subprograms to be used for interpolating between nearly all grids used
at NCEP. The library is particularly efficient when interpolating many
fields at one time.
The NCEP general interpolation library contains Fortran 90 subprograms to be
used for interpolating between nearly all grids used at NCEP. The library is
particularly efficient when interpolating many fields at one time. It also
contains routines for spectral transforms and other processing, including those
previously contained in the NCEPLIBS-sp library.

This is part of the [NCEPLIBS](https://github.com/NOAA-EMC/NCEPLIBS)
project.

There are currently six interpolation methods available in the
library:
There are currently six interpolation methods available in the library:
- bilinear
- bicubic
- neighbor
Expand All @@ -27,11 +27,12 @@ To submit bug reports, feature requests, or other code-related issues including

* NCEP/EMC Developers

Code Manager: [George Gayno](mailto:george.gayno@noaa.gov)
Code Manager: [Alex Richert](mailto:alexander.richert@noaa.gov)

### Prerequisites

This package requires the [NCEPLIBS-sp](https://github.com/NOAA-EMC/NCEPLIBS-sp) library.
This package does not link to any other libraries, but requires CMake (version
3.15+) to build.

### Installing

Expand All @@ -40,27 +41,28 @@ mkdir build
cd build
cmake -DCMAKE_INSTALL_PREFIX=/path/to/install /path/to/NCEPLIBS-ip
make -j2
make test (or ctest --verbose)
make test # (or ctest --verbose)
make install
```

### Usage

To use the ip library add `use ip_mod` to your Fortran code. It contains all the necessary public interfaces.
Most routines and any public interfaces required can be accessed by adding `use
ip_mod` to your Fortran code. Most spectral transform and processing subroutines
can be accessed by calling them in your code (no `use` statement) and linking
to the ip library at build time.

## 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.
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.

0 comments on commit 7bba531

Please sign in to comment.