Skip to main content

Rich NcDump

PyPI PyPI Downloads Status Python Version License Read the documentation at https://ncdump-rich.readthedocs.io/ Tests Codecov pre-commit Black Ruff

Features

This project provides an easy way of previewing netCDF files with nicely formatted text in your terminal. The information extracted from the .nc files are obtained in a similar way to this example, with some modifications. The source code used on the website can be downloaded as netcdf_example.py with:

$ curl -O http://schubert.atmos.colostate.edu/~cslocum/code/netcdf_example.py

To make the output more readable it is formatted using the python library rich.

Requirements

The project depends on the python packages click, netCDF4 and rich. Installation via pip or pipx ensures that all dependencies are installed correctly.

Installation

You can install Rich NcDump via pip from PyPI:

$ pip install ncdump-rich

or perhaps even better via pipx:

$ pipx install ncdump-rich

Usage

Please see the Command-line Reference for details.

https://raw.githubusercontent.com/engeir/ncdump-rich/example-image/latest.png

Examples

Use the program as a previewer for .nc files, for example through stpv. My own fork provides additional support for previewing .nc files using this project.

Preview in lf

./demo/lf-demo.png

Similarly you can get preview of .nc files in nnn by including an option for the extension nc in the preview-tui plugin.

nc) fifo_pager ncdump-rich "$1" ;;

Preview in nnn

./demo/nnn-demo.png

Contributing

Contributions are very welcome. To learn more, see the Contributor Guide.

License

Distributed under the terms of the GPL 3.0 license, Rich NcDump is free and open source software.

Issues

If you encounter any problems, please file an issue along with a detailed description.

Credits

This project was generated from @cjolowicz’s Hypermodern Python Cookiecutter template.

Metadata

Release files for ncdump-rich 0.5.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ncdump-rich 0.5.4
File Size Uploaded
ncdump_rich-0.5.4.tar.gz 33.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for ncdump-rich 0.5.4
File Interpreter ABI Platform
ncdump_rich-0.5.4-py3-none-any.whl Python 3 none any Details

Total release size: 53.1 kB

Release files / ncdump_rich-0.5.4.tar.gz

Download URL ncdump_rich-0.5.4.tar.gz
Size 33.8 kB
Tags Source
SHA-256 checksum
How to use checksums
4655f645547fe140167c0ec0ac07d83e8d0649211d4cebe6c80e757e50c85282
BLAKE2b-256 checksum
How to use checksums
7ba38fb0439e14908993e8c3639f3bd5feed5398517fb8f15d6359fde12e06f8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.13

Release files / ncdump_rich-0.5.4-py3-none-any.whl

Download URL ncdump_rich-0.5.4-py3-none-any.whl
Size 19.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1e429909d10daa4a5c546d41e561e54510276de4f949c1697e544694aa2a80c1
BLAKE2b-256 checksum
How to use checksums
979241238e04b0866ea2eab93f78a1729ac8ed32b87f825fca27fe5b2192d8eb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.13

Release history Release notifications | RSS feed

This release

0.5.4 This release

2 release files

0.5.2

2 release files

0.4.0

2 release files

0.3.4

2 release files

0.3.3

2 release files

0.3.2

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.1

2 release files

0.1.11

2 release files

0.1.9

2 release files

0.1.7

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

1 release file

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page