From 8b643d583d7c6bb069fbaa34fe308126bfae0ac4 Mon Sep 17 00:00:00 2001 From: Eric Engle Date: Mon, 26 Jun 2023 09:06:50 -0400 Subject: [PATCH] Update grib2io_interp package structure grib2io_interp now has an __init__.py for proper package structuring. __version__ string is now available. Minor documentation. --- .gitignore | 2 + create_docs.sh | 2 +- docs/grib2io_interp.html | 46 +++++++++++++++++-- .../{interpolate.html => __config__.html} | 42 ++++++++++++----- docs/search.js | 2 +- setup.py | 29 ++++++------ src/grib2io_interp/__init__.py | 16 +++++++ src/{ => interpolate}/interpolate.f90 | 0 src/{ => interpolate}/interpolate.pyf | 4 ++ 9 files changed, 112 insertions(+), 31 deletions(-) rename docs/grib2io_interp/{interpolate.html => __config__.html} (95%) create mode 100644 src/grib2io_interp/__init__.py rename src/{ => interpolate}/interpolate.f90 (100%) rename src/{ => interpolate}/interpolate.pyf (99%) diff --git a/.gitignore b/.gitignore index 68bc17f..b66b7f0 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,5 @@ +src/grib2io_interp/__config__.py + # Byte-compiled / optimized / DLL files __pycache__/ *.py[cod] diff --git a/create_docs.sh b/create_docs.sh index 17ccc60..163f362 100755 --- a/create_docs.sh +++ b/create_docs.sh @@ -5,4 +5,4 @@ sysarch=$(uname -m) build_dir=$(find . -name "lib.*${sysarch}*" -type d) echo "Building docs from: $build_dir" -pdoc -o 'docs' $build_dir/grib2io_interp +pdoc -o 'docs' $build_dir/grib2io_interp !grib2io_interp.interpolate diff --git a/docs/grib2io_interp.html b/docs/grib2io_interp.html index fd928ae..7715396 100644 --- a/docs/grib2io_interp.html +++ b/docs/grib2io_interp.html @@ -21,10 +21,14 @@ +

Contents

+ +

Submodules

@@ -41,10 +45,42 @@

Submodules

grib2io_interp

- - - - +

Introduction

+ +

grib2io_interp is a component package to the parent package, grib2io. +This package provides interfaces to the NCEPLIBS-ip general +interpolation library.

+ +

grib2io_interp provides interfaces for performing scalar and vector interpolation. grib2io_interp.interpolate is +a f2py module extension that contains 2 subroutines: interpolate_scalar and interpolate_vector. These +subroutines serve as wrappers to the NCEPLIBS-ip subroutines ipolates_grib2 and ipolatev_grib2 respectively.

+ +

It is recommended that you access these interpolateion subroutines via grib2io.interpolate().

+
+ + + + + + 
 1"""
+ 2Introduction
+ 3============
+ 4
+ 5grib2io_interp is a component package to the parent package, [grib2io](https://github.com/NOAA-MDL/grib2io).
+ 6This package provides interfaces to the [NCEPLIBS-ip](https://github.com/NOAA-EMC/NCEPLIBS-ip) general
+ 7interpolation library.
+ 8
+ 9grib2io_interp provides interfaces for performing scalar and vector interpolation.  `grib2io_interp.interpolate` is
+10a f2py module extension that contains 2 subroutines: `interpolate_scalar` and `interpolate_vector`.  These
+11subroutines serve as wrappers to the NCEPLIBS-ip subroutines `ipolates_grib2` and `ipolatev_grib2` respectively.
+12
+13It is **recommended** that you access these interpolateion subroutines via [`grib2io.interpolate()`](https://noaa-mdl.github.io/grib2io/grib2io.html#interpolate).
+14"""
+15
+16from .__config__ import grib2io_interp_version as __version__
+
+ +