| Name | granulemeta JSON |
| Version |
3.3.2
JSON |
| download |
| home_page | |
| Summary | A package designed to generate low-level metadata in a specified/supported format (i.e. gmout) for a file or set of files. |
| upload_time | 2023-10-05 14:49:41 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.6 |
| license | Open Source License Copyright (c) 2019 UT-Battelle, LLC Subject to the conditions of this License, UT-Battelle, LLC (the “Licensor”) hereby grants, free of charge, to any person (the “Licensee”) obtaining a copy of this software and associated documentation files (the "Software"), a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to use, copy, modify, merge, publish, distribute, and/or sublicense copies of the Software. 1. Redistributions of Software must retain the above open source license grant, copyright and license notices, this list of conditions, and the disclaimer listed below. Changes or modifications to, or derivative works of the Software must be noted with comments and the contributor and organization’s name. 2. Neither the names of Licensor, the Department of Energy, or their employees may be used to endorse or promote products derived from this Software without their specific prior written permission. 3. If the Software is protected by a proprietary trademark owned by Licensor or the Department of Energy, then derivative works of the Software may not be distributed using the trademark without the prior written approval of the trademark owner. UT-Battelle, LLC AND THE GOVERNMENT MAKE NO REPRESENTATIONS AND DISCLAIM ALL WARRANTIES, BOTH EXPRESSED AND IMPLIED. THERE ARE NO EXPRESS OR IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, OR THAT THE USE OF THE SOFTWARE WILL NOT INFRINGE ANY PATENT, COPYRIGHT, TRADEMARK, OR OTHER PROPRIETARY RIGHTS, OR THAT THE SOFTWARE WILL ACCOMPLISH THE INTENDED RESULTS OR THAT THE SOFTWARE OR ITS USE WILL NOT RESULT IN INJURY OR DAMAGE. The user assumes responsibility for all liabilities, penalties, fines, claims, causes of action, and costs and expenses, caused by, resulting from or arising out of, in whole or in part the use, storage or disposal of the SOFTWARE. |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
numpy
pandas
netCDF4
tinytag
GDAL
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# granulemeta
This code was originally created as a file-level metadata extraction tool for use by the ORNL DAAC. The update to version 3 represents a complete refactoring in the approach taken by the prior version of ORNL DAAC's file level metadata extraction tool. The refactoring of the code put an emphasis on making the codebase more maintainable and extensible while making the code's execution more consistently stable and yet more flexible in how the code could be utilized by the end-user.
The default output for granulemeta-v3 is a csv in **gmout** format (as is necessary for ORNL DAAC's ingest process), however the code can easily be extended to accomodate other output formats.
## install
```
pip install granulemeta
```
## usage
### Run from the command line:
```
granulemeta.py -o [OUTPUT_FILE].csv [PATH: directory or file or glob]
```
### Run from docker container for local development:
```
./run-docker-dev.sh [PATH TO DATA DIRECTORY] [PATH TO GRANULEMETA CODE DIRECTORY]
```
This will give you a command line environment to run granulemeta in. The first path argument provided will be mounted as `/data` and the second path argument as `/code`. Within the dev container, granulemeta can be run using the following syntax:
```
granulemeta -o [OUTPUT_FILE].csv [PATH: directory or file or glob]
```
## requirements
This script was developed on Python 3. It relies on **five** packages not in Python's standard library:
* `numpy`: https://numpy.org/
* `pandas`: https://pandas.pydata.org/
* `netCDF4`: https://unidata.github.io/netcdf4-python/netCDF4/index.html
* `tinytag`: https://pypi.org/project/tinytag/
* `gdal`: https://gdal.org/python/
[`requirements.txt`](requirements.txt) was last generated on 2022-06-09.
## notes
Notable features added since the creation of version 3:
* Lines are written to the output file as it processes each granule instead of waiting until all granules have been processed to write the output file.
* Unless the `--overwrite` option is given, the script will skip granules already present in the output file. This (coupled with the feature directly above) will allow the script to pick up where it left off if it crashes partway through processing a dataset.
* There is a `--nfiles` (or `-n`) option that allows the script to automatically stop execution after processing a specified number of granules.
* [Glob syntax](https://en.wikipedia.org/wiki/Glob_(programming)) can now be used for the input `path` argument to allow a user to restrict the files that a given execution of the script processes (i.e. using `/path/*.nc` as your input path would only process granules with the `.nc` file extension).
* Behind the scenes, the code is better organized to better facilitate redability, maintainability, and extensibility. This has been accomplished by breaking the code up into several modules.
## authorship
The following authors have contributed to the granulemeta development process:
Kent Campbell, Jack McNelis, Vinny Palandro, Yaxing Wei, Tammy Walker, Matt Donovan, Jessica Welch, Daine Wright, Bruce Wilson, Chris Lindsley, Ketan Patel, Scott Pearson, Rupesh Shrestha, Tom Ruggles
## contacts
author: campbellkb@ornl.gov
Raw data
{
"_id": null,
"home_page": "",
"name": "granulemeta",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "",
"author_email": "\"Kent B. Campbell\" <campbellkb@ornl.gov>",
"download_url": "https://files.pythonhosted.org/packages/9a/e2/02b3887d5ad0877ec41a858fd5d8ea8ff40c7b17e37dfa2c1445d55dc9cf/granulemeta-3.3.2.tar.gz",
"platform": null,
"description": "# granulemeta\n\n\nThis code was originally created as a file-level metadata extraction tool for use by the ORNL DAAC. The update to version 3 represents a complete refactoring in the approach taken by the prior version of ORNL DAAC's file level metadata extraction tool. The refactoring of the code put an emphasis on making the codebase more maintainable and extensible while making the code's execution more consistently stable and yet more flexible in how the code could be utilized by the end-user. \n\nThe default output for granulemeta-v3 is a csv in **gmout** format (as is necessary for ORNL DAAC's ingest process), however the code can easily be extended to accomodate other output formats. \n\n## install\n\n```\npip install granulemeta\n```\n\n## usage\n\n### Run from the command line:\n\n```\ngranulemeta.py -o [OUTPUT_FILE].csv [PATH: directory or file or glob]\n```\n\n### Run from docker container for local development:\n```\n./run-docker-dev.sh [PATH TO DATA DIRECTORY] [PATH TO GRANULEMETA CODE DIRECTORY]\n```\n\nThis will give you a command line environment to run granulemeta in. The first path argument provided will be mounted as `/data` and the second path argument as `/code`. Within the dev container, granulemeta can be run using the following syntax:\n```\ngranulemeta -o [OUTPUT_FILE].csv [PATH: directory or file or glob]\n```\n\n## requirements\nThis script was developed on Python 3. It relies on **five** packages not in Python's standard library:\n\n* `numpy`: https://numpy.org/\n* `pandas`: https://pandas.pydata.org/\n* `netCDF4`: https://unidata.github.io/netcdf4-python/netCDF4/index.html\n* `tinytag`: https://pypi.org/project/tinytag/\n* `gdal`: https://gdal.org/python/\n\n[`requirements.txt`](requirements.txt) was last generated on 2022-06-09.\n\n## notes\nNotable features added since the creation of version 3:\n* Lines are written to the output file as it processes each granule instead of waiting until all granules have been processed to write the output file.\n* Unless the `--overwrite` option is given, the script will skip granules already present in the output file. This (coupled with the feature directly above) will allow the script to pick up where it left off if it crashes partway through processing a dataset.\n* There is a `--nfiles` (or `-n`) option that allows the script to automatically stop execution after processing a specified number of granules.\n* [Glob syntax](https://en.wikipedia.org/wiki/Glob_(programming)) can now be used for the input `path` argument to allow a user to restrict the files that a given execution of the script processes (i.e. using `/path/*.nc` as your input path would only process granules with the `.nc` file extension).\n* Behind the scenes, the code is better organized to better facilitate redability, maintainability, and extensibility. This has been accomplished by breaking the code up into several modules.\n\n## authorship\nThe following authors have contributed to the granulemeta development process:\n\nKent Campbell, Jack McNelis, Vinny Palandro, Yaxing Wei, Tammy Walker, Matt Donovan, Jessica Welch, Daine Wright, Bruce Wilson, Chris Lindsley, Ketan Patel, Scott Pearson, Rupesh Shrestha, Tom Ruggles\n\n## contacts\nauthor: campbellkb@ornl.gov",
"bugtrack_url": null,
"license": "Open Source License Copyright (c) 2019 UT-Battelle, LLC Subject to the conditions of this License, UT-Battelle, LLC (the \u201cLicensor\u201d) hereby grants, free of charge, to any person (the \u201cLicensee\u201d) obtaining a copy of this software and associated documentation files (the \"Software\"), a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to use, copy, modify, merge, publish, distribute, and/or sublicense copies of the Software. 1. Redistributions of Software must retain the above open source license grant, copyright and license notices, this list of conditions, and the disclaimer listed below. Changes or modifications to, or derivative works of the Software must be noted with comments and the contributor and organization\u2019s name. 2. Neither the names of Licensor, the Department of Energy, or their employees may be used to endorse or promote products derived from this Software without their specific prior written permission. 3. If the Software is protected by a proprietary trademark owned by Licensor or the Department of Energy, then derivative works of the Software may not be distributed using the trademark without the prior written approval of the trademark owner. UT-Battelle, LLC AND THE GOVERNMENT MAKE NO REPRESENTATIONS AND DISCLAIM ALL WARRANTIES, BOTH EXPRESSED AND IMPLIED. THERE ARE NO EXPRESS OR IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, OR THAT THE USE OF THE SOFTWARE WILL NOT INFRINGE ANY PATENT, COPYRIGHT, TRADEMARK, OR OTHER PROPRIETARY RIGHTS, OR THAT THE SOFTWARE WILL ACCOMPLISH THE INTENDED RESULTS OR THAT THE SOFTWARE OR ITS USE WILL NOT RESULT IN INJURY OR DAMAGE. The user assumes responsibility for all liabilities, penalties, fines, claims, causes of action, and costs and expenses, caused by, resulting from or arising out of, in whole or in part the use, storage or disposal of the SOFTWARE.",
"summary": "A package designed to generate low-level metadata in a specified/supported format (i.e. gmout) for a file or set of files.",
"version": "3.3.2",
"project_urls": {
"Homepage": "https://github.com/ornldaac/granulemeta"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a28e5df85df4e69f7923d66bd22f30db76233fd43b716460d62d7f8d5956a224",
"md5": "8af548ff1faad6fc381f754c4751a4d3",
"sha256": "cb6beb858a189c5d447b9d62af1ff4312e07bc2f0e59d1290e435c5bf071f15f"
},
"downloads": -1,
"filename": "granulemeta-3.3.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8af548ff1faad6fc381f754c4751a4d3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 62789,
"upload_time": "2023-10-05T14:49:39",
"upload_time_iso_8601": "2023-10-05T14:49:39.845739Z",
"url": "https://files.pythonhosted.org/packages/a2/8e/5df85df4e69f7923d66bd22f30db76233fd43b716460d62d7f8d5956a224/granulemeta-3.3.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9ae202b3887d5ad0877ec41a858fd5d8ea8ff40c7b17e37dfa2c1445d55dc9cf",
"md5": "6308f33fd55ba68426cb76938d1a6411",
"sha256": "d42c41c301b3171e4e152a151f19e5c6e1e143b3ef345b6b911686e8b7c1b0a4"
},
"downloads": -1,
"filename": "granulemeta-3.3.2.tar.gz",
"has_sig": false,
"md5_digest": "6308f33fd55ba68426cb76938d1a6411",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 51952,
"upload_time": "2023-10-05T14:49:41",
"upload_time_iso_8601": "2023-10-05T14:49:41.556728Z",
"url": "https://files.pythonhosted.org/packages/9a/e2/02b3887d5ad0877ec41a858fd5d8ea8ff40c7b17e37dfa2c1445d55dc9cf/granulemeta-3.3.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-05 14:49:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ornldaac",
"github_project": "granulemeta",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "numpy",
"specs": [
[
">=",
"1.18.1"
]
]
},
{
"name": "pandas",
"specs": [
[
">=",
"1.0.0"
]
]
},
{
"name": "netCDF4",
"specs": [
[
">=",
"1.5.3"
]
]
},
{
"name": "tinytag",
"specs": [
[
">=",
"1.4.0"
]
]
},
{
"name": "GDAL",
"specs": [
[
">=",
"3.0.4"
]
]
}
],
"lcname": "granulemeta"
}
