Skip to main content

tool for extrapolating NetCDF files

Project description

ncgrow

To grow/extend masked fields so they extend into the mask. Developed mainly to extend ocean data with a land-sea mask either after regridding or for visualization. The script computes weights and indices iteratively and then applies them

Installation

ncgrow can be installed after downloading this repository by running:

python3 setup.py install [--user]

It can also be installed directly from the Python Packaging Index (PyPI) by running:

pip3 install ncgrow

Development

Packaging

Create distribution:

python3 setup.py sdist bdist_wheel

After that the package can be uploaded to PyPI.

Usage

The ncgrow script has the following usage.

usage: ncgrow [-h] [-v [..]] [-d [..]] [-m [..]] [--maskfile filename]
              [--smooth [..]] [--fill [..]] [-i [..]] [--niter_chunks [..]]
              [-c [..]] [-O] [-V] [--version]
              infile outfile

Grow/extend and/or fill masked fields.

positional arguments:
 infile                path to source file.
 outfile               filename of the output file.

optional arguments:
 -h, --help            show this help message and exit
 -v [..], --variables [..]
                       list of variables to extend, e.g. -v temp,elev.
 -d [..], --dims [..]  Dimension subset, e.g. -d level,1,10,2
 -m [..], --maskvar [..]
                       Variable name for land-sea mask that will be the
                       enforced.
 --maskfile filename   External file containing mask variable(s), i.e.
                       maskvar. Will be used before infile in case maskvar is
                       present in both.
 --smooth [..]         Smooth grown cells to avoid unphysical values. Can
                       also be specified per variable, e.g. --smooth
                       True,temp, --smooth False,ice. default is True.
 --fill [..]           Default value to apply to any cells that are not
                       missing_value or Fillvalue in maskvar. Will be ignored
                       if --maskvar is not set. Optionally one can select
                       'max' 'min', 'mean' of variable or None. Can also be
                       specified per variable, e.g. --fill mean, temp, --fill
                       0,ice.
 -i [..], --iterations [..]
                       Number of iterations to use, corresponds to one land
                       cell per iteration. optionally with variable name
                       appended, e.g. -i 2,temp,elev. Multiple defintions
                       possible for granulated control.
 --niter_chunks [..]   Maximum number of iterations to hold in memory. Will
                       reduce performance, but enable larger dataset and
                       number of iterations. Optionally with variable name
                       appended. Multiple defintions possible for granulated
                       control. Default is 5.
 -c [..], --converge [..]
                       Converge towards a given value 'V' with a factor f =
                       [0-1] (default = 1). If not set no convergence is
                       applied. e.g. -c 0,0.25,ice. Multiple defintions
                       possible for granulated control.
 -O, --overwrite       Overwrite output file if it exist (or append to input
                       file).
 -V, --verbose         Increase runtime information.
 --version             show program's version number and exit

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

ncgrow-1.6.8.tar.gz (15.8 kB view details)

Uploaded Source

Built Distribution

ncgrow-1.6.8-py3-none-any.whl (21.7 kB view details)

Uploaded Python 3

File details

Details for the file ncgrow-1.6.8.tar.gz.

File metadata

  • Download URL: ncgrow-1.6.8.tar.gz
  • Upload date:
  • Size: 15.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.6.2 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.7

File hashes

Hashes for ncgrow-1.6.8.tar.gz
Algorithm Hash digest
SHA256 6d038cc2285cc03009a663408b6d9450e8181c86aa4e2e4b1bdb91b5511f042d
MD5 c970e8c2c8b7b9ae4a99e85e0e39394d
BLAKE2b-256 1219084993d81aa84b41a1632bc7243a6f6c2aad5cacc608dfa48cc30e96ee75

See more details on using hashes here.

File details

Details for the file ncgrow-1.6.8-py3-none-any.whl.

File metadata

  • Download URL: ncgrow-1.6.8-py3-none-any.whl
  • Upload date:
  • Size: 21.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.6.2 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.7

File hashes

Hashes for ncgrow-1.6.8-py3-none-any.whl
Algorithm Hash digest
SHA256 e580a3ea3709f67937f7968b17fceaddc23994a98ab0e732a16771d16c017cb9
MD5 735bda744cbd434cc608dd14a94337f3
BLAKE2b-256 4bcb858d7bfaf0116a4bd146b43b7f80e6a57c6727dc0a58d48193fe186c1673

See more details on using hashes here.

Supported by

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