| Name | ncCompare JSON |
| Version |
0.2.2
JSON |
| download |
| home_page | None |
| Summary | netCDF Comparison Tool |
| upload_time | 2024-08-06 13:44:41 |
| maintainer | None |
| docs_url | None |
| author | Antonio Mariani |
| requires_python | <4.0,>=3.10 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# netCDF Diff Comparison tool - ncpare
`ncpare` is a tool for comparing netCDF files, providing a detailed diff of their contents. It is designed to help users
identify differences between datasets stored in netCDF format.
[](https://anaconda.org/)
[](https://pypi.org/project/pip/)
[](https://pypi.org/project/pip/)
[](https://pypi.org/project/pip/)
[](https://github.com/Textualize/rich?tab=readme-ov-file)
## Installation
### Via PIP
```shell
pip install nccompare
```
## Usage
```shell
ncpare [-h] [-f--filter FILTER_NAME] [--common_pattern COMMON_PATTERN] [--variables VARIABLES [VARIABLES ...]] [--last_time_step] [-V] folder1 folder2
netCDF Comparison Tool
positional arguments:
folder1 Path of first folder to compare
folder2 Path of second folder to compare
options:
-h, --help show this help message and exit
-f--filter FILTER_NAME
Filter to select files to compare. Examples: *.nc, *_grid_*
--common_pattern COMMON_PATTERN
Common file pattern in two files to compareEs mfsX_date.nc and expX_date.nc -> date.nc is the common part
-v, --variables VARIABLES [VARIABLES ...]
Variable to compare
--last_time_step If True, compare only the last time step available in each file
-V, --version Print version and exit
```
### Select Variables
It is possible to choose which parameter to compare:
```shell
ncpare folder1 folder2 -v "votemper" "vosaline"
```
### Filter files
As default **ncpare** read iterate over all files in **folder1** and expect to find them in **folder2**. Using filters,
it is possible to select only a subset of input files. For example:
```shell
ncpare folder1 folder2 -f "*_grid_T.nc"
```
### Compare files with different filenames
It is possible to compare two files also if the filenames are slightly different if they have a common pattern.
For example, if we have:
* `a/my-simu_19820101_grid_T.nc`
* `b/another-exp_19820101_grid_T.nc`
It is still possible to compare the file with:
```shell
ncpare folder1 folder2 --commom-pattern ".+_19820101_grid_T.nc"
```
Notice the regex syntax `.+` to match any pattern before `_19820101`
## Author
- Antonio Mariani (antonio.mariani@cmcc.it)
## Contributing
Contributions are welcome! Please open an issue or submit a pull request for any improvements or bug fixes.
## Contact
For any questions or suggestions, please open an issue on the project's GitHub repository.
Raw data
{
"_id": null,
"home_page": null,
"name": "ncCompare",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": null,
"author": "Antonio Mariani",
"author_email": "antonio.mariani@cmcc.it",
"download_url": "https://files.pythonhosted.org/packages/f1/2b/775d57d9f33bcef75f4ba2a4eb13f5e460e660dbc342d39845c79317b594/nccompare-0.2.2.tar.gz",
"platform": null,
"description": "# netCDF Diff Comparison tool - ncpare\n\n`ncpare` is a tool for comparing netCDF files, providing a detailed diff of their contents. It is designed to help users\nidentify differences between datasets stored in netCDF format.\n\n\n[](https://anaconda.org/)\n[](https://pypi.org/project/pip/)\n[](https://pypi.org/project/pip/)\n[](https://pypi.org/project/pip/)\n[](https://github.com/Textualize/rich?tab=readme-ov-file)\n\n\n\n\n## Installation\n\n### Via PIP\n\n```shell\npip install nccompare\n```\n\n## Usage\n\n```shell\nncpare [-h] [-f--filter FILTER_NAME] [--common_pattern COMMON_PATTERN] [--variables VARIABLES [VARIABLES ...]] [--last_time_step] [-V] folder1 folder2\n\nnetCDF Comparison Tool\n\npositional arguments:\n folder1 Path of first folder to compare\n folder2 Path of second folder to compare\n\noptions:\n -h, --help show this help message and exit\n -f--filter FILTER_NAME\n Filter to select files to compare. Examples: *.nc, *_grid_*\n --common_pattern COMMON_PATTERN\n Common file pattern in two files to compareEs mfsX_date.nc and expX_date.nc -> date.nc is the common part\n -v, --variables VARIABLES [VARIABLES ...]\n Variable to compare\n --last_time_step If True, compare only the last time step available in each file\n -V, --version Print version and exit\n\n```\n\n### Select Variables\n\nIt is possible to choose which parameter to compare:\n\n```shell\nncpare folder1 folder2 -v \"votemper\" \"vosaline\"\n```\n\n\n\n\n### Filter files\n\nAs default **ncpare** read iterate over all files in **folder1** and expect to find them in **folder2**. Using filters,\nit is possible to select only a subset of input files. For example:\n\n```shell\nncpare folder1 folder2 -f \"*_grid_T.nc\"\n```\n\n### Compare files with different filenames\n\nIt is possible to compare two files also if the filenames are slightly different if they have a common pattern.\nFor example, if we have:\n\n* `a/my-simu_19820101_grid_T.nc`\n* `b/another-exp_19820101_grid_T.nc`\n\nIt is still possible to compare the file with:\n```shell\nncpare folder1 folder2 --commom-pattern \".+_19820101_grid_T.nc\"\n```\n\nNotice the regex syntax `.+` to match any pattern before `_19820101`\n\n## Author\n\n- Antonio Mariani (antonio.mariani@cmcc.it)\n\n## Contributing\nContributions are welcome! Please open an issue or submit a pull request for any improvements or bug fixes.\n\n## Contact\nFor any questions or suggestions, please open an issue on the project's GitHub repository.\n",
"bugtrack_url": null,
"license": null,
"summary": "netCDF Comparison Tool",
"version": "0.2.2",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ef4aaaf52c6c4fc3c60e680d4f7cd04440aacce5106730dcd1c5b203e66773d8",
"md5": "370c8cbac8589eca6a48cf88b43b9301",
"sha256": "6682f1e14f356a58e92792e2f501e4910168ad28a84570b3107fdb6cf4e1a6f9"
},
"downloads": -1,
"filename": "nccompare-0.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "370c8cbac8589eca6a48cf88b43b9301",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 14141,
"upload_time": "2024-08-06T13:44:40",
"upload_time_iso_8601": "2024-08-06T13:44:40.326902Z",
"url": "https://files.pythonhosted.org/packages/ef/4a/aaf52c6c4fc3c60e680d4f7cd04440aacce5106730dcd1c5b203e66773d8/nccompare-0.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f12b775d57d9f33bcef75f4ba2a4eb13f5e460e660dbc342d39845c79317b594",
"md5": "fd47e52d55f3ed52365d74fb3a6553ef",
"sha256": "4d8e893d557a800a74d5cb0d0b7a51240ba6db94f54c90b872163eb8d1741cd1"
},
"downloads": -1,
"filename": "nccompare-0.2.2.tar.gz",
"has_sig": false,
"md5_digest": "fd47e52d55f3ed52365d74fb3a6553ef",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 10304,
"upload_time": "2024-08-06T13:44:41",
"upload_time_iso_8601": "2024-08-06T13:44:41.830295Z",
"url": "https://files.pythonhosted.org/packages/f1/2b/775d57d9f33bcef75f4ba2a4eb13f5e460e660dbc342d39845c79317b594/nccompare-0.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-06 13:44:41",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "nccompare"
}
