# modisconverter
`modisconverter` is a Python package that converts MODIS data from HDF4 to NetCDF4 file format.
## Prequisites
- Python >= 3.9
- GDAL >= 3.1.2, with supported file formats `HDF4` and `netCDF`
## Installation
This package is available on [PyPI](https://pypi.org/project/modisconverter/) and can be installed with [pip](https://pip.pypa.io/en/stable/user_guide/).
Package install depends on having a Python `GDAL` package that matches the version of the underlying GDAL installation. It also requires the `rasterio` package to be built from source.
```bash
$ pip install GDAL==<installed-version-number> --no-binary rasterio modisconverter
```
e.g.
```bash
$ pip install GDAL==3.6.3 --no-binary rasterio modisconverter
```
You can find your installed GDAL version by using the `gdal-config` binary:
```bash
$ gdal-config --version
```
## Environment Considerations
It's recommended to install the package in a [virtual environment](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/). Otherwise, if your machine can run Docker containers, installing the package in one provides natural isolation.
For potential Docker images, you could consider using one of the [official GDAL images](https://hub.docker.com/r/osgeo/gdal/tags) from DockerHub, which contain a GDAL and Python installation. For instance, the Ubuntu-based image `ghcr.io/osgeo/gdal:ubuntu-full-3.6.3`. Note that the `pip` package manager may not be installed in such images.
## Usage
```python
from modisconverter import convert_file
src = 'example-modis.hdf'
dst = 'example-modis.nc'
convert_file(src, dst)
```
## Documentation
Listed below are various documents pertaining to this project.
- [Changelog](CHANGELOG.md) - Information on releases.
- [Usage](docs/USAGE.md) - Detailed usage of the library.
Raw data
{
"_id": null,
"home_page": "https://github.com/nasa/modisconverter",
"name": "modisconverter",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9, <4",
"maintainer_email": "",
"keywords": "MODIS,Converter,HDF4,NetCDF4",
"author": "",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/77/26/1831d32d506f8281b0e004c32c26ab72b4bfaf83bf9fe24274e8a6ae761d/modisconverter-0.2.0.tar.gz",
"platform": null,
"description": "# modisconverter\n\n`modisconverter` is a Python package that converts MODIS data from HDF4 to NetCDF4 file format.\n\n## Prequisites\n\n- Python >= 3.9\n- GDAL >= 3.1.2, with supported file formats `HDF4` and `netCDF`\n\n## Installation\n\nThis package is available on [PyPI](https://pypi.org/project/modisconverter/) and can be installed with [pip](https://pip.pypa.io/en/stable/user_guide/).\n\nPackage install depends on having a Python `GDAL` package that matches the version of the underlying GDAL installation. It also requires the `rasterio` package to be built from source.\n\n```bash\n$ pip install GDAL==<installed-version-number> --no-binary rasterio modisconverter\n```\n\ne.g.\n\n```bash\n$ pip install GDAL==3.6.3 --no-binary rasterio modisconverter\n```\n\nYou can find your installed GDAL version by using the `gdal-config` binary:\n\n```bash\n$ gdal-config --version\n```\n\n## Environment Considerations\n\nIt's recommended to install the package in a [virtual environment](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/). Otherwise, if your machine can run Docker containers, installing the package in one provides natural isolation.\n\nFor potential Docker images, you could consider using one of the [official GDAL images](https://hub.docker.com/r/osgeo/gdal/tags) from DockerHub, which contain a GDAL and Python installation. For instance, the Ubuntu-based image `ghcr.io/osgeo/gdal:ubuntu-full-3.6.3`. Note that the `pip` package manager may not be installed in such images.\n\n## Usage\n\n```python\nfrom modisconverter import convert_file\n\nsrc = 'example-modis.hdf'\ndst = 'example-modis.nc'\nconvert_file(src, dst)\n```\n\n## Documentation\n\nListed below are various documents pertaining to this project.\n\n- [Changelog](CHANGELOG.md) - Information on releases.\n- [Usage](docs/USAGE.md) - Detailed usage of the library.\n",
"bugtrack_url": null,
"license": "",
"summary": "A library for converting MODIS data files",
"version": "0.2.0",
"project_urls": {
"Homepage": "https://github.com/nasa/modisconverter"
},
"split_keywords": [
"modis",
"converter",
"hdf4",
"netcdf4"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a72f98d4178c02849b85ddf82c8095b0043c763a9efc96408dba2076aae7c972",
"md5": "b69521efe7a457f21a8e537ba10c792f",
"sha256": "c002d982e0590d6d396bcac1faa892e2d18838465083b9a800b29076d5cfe6d9"
},
"downloads": -1,
"filename": "modisconverter-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b69521efe7a457f21a8e537ba10c792f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9, <4",
"size": 21616,
"upload_time": "2023-09-12T16:52:33",
"upload_time_iso_8601": "2023-09-12T16:52:33.293315Z",
"url": "https://files.pythonhosted.org/packages/a7/2f/98d4178c02849b85ddf82c8095b0043c763a9efc96408dba2076aae7c972/modisconverter-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "77261831d32d506f8281b0e004c32c26ab72b4bfaf83bf9fe24274e8a6ae761d",
"md5": "36b0030846612638bf786a7f87e45ea7",
"sha256": "2cd5b56ea40be080ec125c582777cede81746428d8b90de1cb60df36151b20a1"
},
"downloads": -1,
"filename": "modisconverter-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "36b0030846612638bf786a7f87e45ea7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9, <4",
"size": 18161,
"upload_time": "2023-09-12T16:52:35",
"upload_time_iso_8601": "2023-09-12T16:52:35.088701Z",
"url": "https://files.pythonhosted.org/packages/77/26/1831d32d506f8281b0e004c32c26ab72b4bfaf83bf9fe24274e8a6ae761d/modisconverter-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-12 16:52:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nasa",
"github_project": "modisconverter",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "modisconverter"
}
JSON
