nctoolkit
nctoolkit: A Python package for netCDF analysis and post-processing - Published in JOSS (2023)
Science Score: 98.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 4 DOI reference(s) in README and JOSS metadata -
✓Academic publication links
Links to: joss.theoj.org -
✓Committers with academic emails
1 of 6 committers (16.7%) from academic institutions -
✓Institutional organization owner
Organization pmlmodelling has institutional domain (pml.ac.uk) -
✓JOSS paper metadata
Published in Journal of Open Source Software
Keywords
Keywords from Contributors
Scientific Fields
Repository
A Python package for netCDF analysis and post-processing
Basic Info
- Host: GitHub
- Owner: pmlmodelling
- License: gpl-3.0
- Language: Python
- Default Branch: master
- Homepage: https://nctoolkit.readthedocs.io/en/latest/
- Size: 423 MB
Statistics
- Stars: 83
- Watchers: 3
- Forks: 11
- Open Issues: 40
- Releases: 71
Topics
Metadata Files
README.md
nctoolkit - A Python package for netCDF analysis and post-processing
nctoolkit is a comprehensive Python (3.8 and above) package for analyzing netCDF data on Linux and macOS.
Core abilities include: - Clipping to spatial regions - Calculating climatologies - Subsetting to specific time periods - Calculating spatial statistics - Creating new variables using arithmetic operations - Calculating anomalies - Calculating rolling and cumulative statistics - Horizontally and vertically remapping data - Calculating time averages - Interactive plotting of data - Calculating the correlations between variables - Calculating vertical statistics for the likes of oceanic data - Calculating ensemble statistics - Calculating phenological metrics
Installation
The easiest way to install the package is using conda or mamba. This will install nctoolkit and all system dependencies.
sh
conda install -c conda-forge nctoolkit
mamba install -c conda-forge nctoolkit
If you install using conda, please be aware that conda can install a very old version of nctoolkit. Consider setting it to a more recent version.
Install through PyPI using pip:
sh
pip install nctoolkit
Install the development version using using pip:
sh
pip install git+https://github.com/pmlmodelling/nctoolkit.git
This package requires the installation of Climate Data Operators. The conda installation will handle this for you. Otherwise, you will have to install it. The easiest way is using conda:
sh
conda install -c conda-forge cdo
A couple of methods give users the option of using NetCDF Operators instead of CDO as the computational backend. Again, the easiest way to install is using conda:
sh
conda install -c conda-forge nco
If you want to install CDO from source, bash scripts are available here.
nctoolkit is tested with continuous integration using Circle CI (for Linux) and GitHub actions (for Mac OS). It will not work on Windows platforms today or in future, because of system dependency limitations.
Reference and tutorials
A full API reference, in depth tutorials and a how-to guide are available at readthedocs.
Contributing
If you are interesting in contributing to nctoolkit feel free to read the Contributing page.
Got questions about nctoolkit?
- If you have a question about how to use nctoolkit, please ask on GitHub Discussions.
- Report any bugs, suggest new features or view the source code on GitHub.
Owner
- Name: Marine Systems Modelling group at the Plymouth Marine Laboratory
- Login: pmlmodelling
- Kind: organization
- Website: https://pml.ac.uk/science/Marine-Systems-Modelling
- Repositories: 9
- Profile: https://github.com/pmlmodelling
JOSS Publication
nctoolkit: A Python package for netCDF analysis and post-processing
Authors
Plymouth Marine Laboratory, The Hoe, Plymouth, UK
Plymouth Marine Laboratory, The Hoe, Plymouth, UK
Editor
Martin Fleischmann
Tags
climate netCDFGitHub Events
Total
- Create event: 3
- Issues event: 1
- Release event: 4
- Watch event: 6
- Issue comment event: 1
- Push event: 45
- Pull request event: 2
- Fork event: 1
Last Year
- Create event: 3
- Issues event: 1
- Release event: 4
- Watch event: 6
- Issue comment event: 1
- Push event: 45
- Pull request event: 2
- Fork event: 1
Committers
Last synced: 5 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Robert Wilson | r****0@g****m | 3,875 |
| Robert Wilson | r****i@p****k | 66 |
| Valeriu Predoi | v****i@g****m | 3 |
| dependabot[bot] | 4****] | 2 |
| Yuri Artioli | 4****L | 1 |
| Anjali0909 | 5****9 | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 4 months ago
All Time
- Total issues: 72
- Total pull requests: 40
- Average time to close issues: about 2 months
- Average time to close pull requests: 3 months
- Total issue authors: 23
- Total pull request authors: 5
- Average comments per issue: 3.72
- Average comments per pull request: 0.68
- Merged pull requests: 5
- Bot issues: 0
- Bot pull requests: 2
Past Year
- Issues: 3
- Pull requests: 1
- Average time to close issues: N/A
- Average time to close pull requests: about 6 hours
- Issue authors: 3
- Pull request authors: 1
- Average comments per issue: 5.0
- Average comments per pull request: 0.0
- Merged pull requests: 1
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- robertjwilson (18)
- malmans2 (12)
- platipodium (11)
- agheysari (5)
- chuaxr (3)
- ledm (2)
- Jashaviti (2)
- Gilaverbuch (2)
- pravee3 (1)
- break2make (1)
- christensen5 (1)
- dpokras (1)
- DavidEHayden (1)
- fipoucat (1)
- MatthewChinappa (1)
Pull Request Authors
- robertjwilson (24)
- snyk-bot (11)
- dependabot[bot] (2)
- valeriupredoi (1)
- Anjali0909 (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 846 last-month
- Total dependent packages: 0
- Total dependent repositories: 2
- Total versions: 72
- Total maintainers: 1
pypi.org: nctoolkit
A Python package for netCDF analysis and post-processing
- Homepage: https://github.com/pmlmodelling/nctoolkit
- Documentation: https://nctoolkit.readthedocs.io/en/stable
- License: GNU General Public License v3 (GPLv3)
-
Latest release: 1.2.3
published 5 months ago
Rankings
Maintainers (1)
Dependencies
- hvplot *
- netCDF4 *
- pandas *
- panel *
- xarray *
- actions/checkout v2 composite
- codecov/codecov-action v2 composite
- goanpeca/setup-miniconda v1 composite
- actions/checkout v2 composite
- actions/setup-python v2 composite
- actions/checkout v3 composite
- mamba-org/setup-micromamba v1 composite