# bufr2geojson
The bufr2geojson Python module contains both a command line interface and an API to convert data stored as WMO BUFR to GeoJSON (RFC 7946).
More information on the BUFR format can be found in the [WMO Manual on Codes, Volume I.2](https://library.wmo.int/doc_num.php?explnum_id=10722).
## Installation
### Requirements
- Python 3 and above
- [ecCodes](https://confluence.ecmwf.int/display/ECC)
### Dependencies
Dependencies are listed in [requirements.txt](https://github.com/wmo-im/bufr2geojson/blob/main/requirements.txt). Dependencies are automatically installed during bufr2geojson installation.
```bash
# download and build Docker image
git clone https://github.com/wmo-im/bufr2geojson.git
cd bufr2geojson
docker build -t bufr2geojson .
# login to Docker container
docker run -it -v ${pwd}:/app bufr2geojson
cd /app
```
## Running
```bash
bufr2geojson data transform <input_file> --output-dir <output_directory> --csv <True|False>
```
e.g.
```bash
bufr2geojson data transform ./tests/A_ISIA21EIDB202100_C_EDZW_20220320210902_11839953.bin --output-dir ./output/
```
## Releasing
```bash
# create release (x.y.z is the release version)
vi bufr2geojson/__init__.py # update __version__
git commit -am 'update release version vx.y.z'
git push origin main
git tag -a vx.y.z -m 'tagging release version vx.y.z'
git push --tags
# upload to PyPI
rm -fr build dist *.egg-info
python setup.py sdist bdist_wheel --universal
twine upload dist/*
# publish release on GitHub (https://github.com/wmo-im/bufr2geojson/releases/new)
# bump version back to dev
vi bufr2geojson/__init__.py # update __version__
git commit -am 'back to dev'
git push origin main
```
## Documentation
The full documentation for bufr2geojson can be found at [https://bufr2geojson.readthedocs.io](https://bufr2geojson.readthedocs.io), including sample files.
### Code Conventions
* [PEP8](https://www.python.org/dev/peps/pep-0008)
### Bugs and Issues
All bugs, enhancements and issues are managed on [GitHub](https://github.com/wmo-im/bufr2geojson/issues).
## Contact
* [David Berry](https://github.com/david-i-berry)
Raw data
{
"_id": null,
"home_page": "https://github.com/wmo-im/bufr2geojson",
"name": "bufr2geojson",
"maintainer": "David I. Berry",
"docs_url": null,
"requires_python": null,
"maintainer_email": "DBerry@wmo.int",
"keywords": "WMO BUFR csv encoding weather observations",
"author": "David I. Berry",
"author_email": "DBerry@wmo.int",
"download_url": "https://files.pythonhosted.org/packages/ca/dc/aa5aa8951f2d13c8317afb1718544748eef26c548160b4e534049d9f1cec/bufr2geojson-0.6.0.tar.gz",
"platform": "all",
"description": "# bufr2geojson\n\nThe bufr2geojson Python module contains both a command line interface and an API to convert data stored as WMO BUFR to GeoJSON (RFC 7946).\nMore information on the BUFR format can be found in the [WMO Manual on Codes, Volume I.2](https://library.wmo.int/doc_num.php?explnum_id=10722).\n\n## Installation\n\n### Requirements\n- Python 3 and above\n- [ecCodes](https://confluence.ecmwf.int/display/ECC)\n\n### Dependencies\n\nDependencies are listed in [requirements.txt](https://github.com/wmo-im/bufr2geojson/blob/main/requirements.txt). Dependencies are automatically installed during bufr2geojson installation.\n\n```bash\n# download and build Docker image\ngit clone https://github.com/wmo-im/bufr2geojson.git\ncd bufr2geojson\ndocker build -t bufr2geojson .\n\n# login to Docker container\ndocker run -it -v ${pwd}:/app bufr2geojson\ncd /app\n```\n\n## Running\n\n```bash\nbufr2geojson data transform <input_file> --output-dir <output_directory> --csv <True|False>\n```\n\ne.g.\n\n```bash\nbufr2geojson data transform ./tests/A_ISIA21EIDB202100_C_EDZW_20220320210902_11839953.bin --output-dir ./output/\n```\n\n## Releasing\n\n```bash\n# create release (x.y.z is the release version)\nvi bufr2geojson/__init__.py # update __version__\ngit commit -am 'update release version vx.y.z'\ngit push origin main\ngit tag -a vx.y.z -m 'tagging release version vx.y.z'\ngit push --tags\n\n# upload to PyPI\nrm -fr build dist *.egg-info\npython setup.py sdist bdist_wheel --universal\ntwine upload dist/*\n\n# publish release on GitHub (https://github.com/wmo-im/bufr2geojson/releases/new)\n\n# bump version back to dev\nvi bufr2geojson/__init__.py # update __version__\ngit commit -am 'back to dev'\ngit push origin main\n```\n\n## Documentation\n\nThe full documentation for bufr2geojson can be found at [https://bufr2geojson.readthedocs.io](https://bufr2geojson.readthedocs.io), including sample files.\n\n### Code Conventions\n\n* [PEP8](https://www.python.org/dev/peps/pep-0008)\n\n### Bugs and Issues\n\nAll bugs, enhancements and issues are managed on [GitHub](https://github.com/wmo-im/bufr2geojson/issues).\n\n## Contact\n\n* [David Berry](https://github.com/david-i-berry)\n",
"bugtrack_url": null,
"license": "Apache Software License",
"summary": "Configurable module to convert data from CSV to WMO BUFR format",
"version": "0.6.0",
"project_urls": {
"Homepage": "https://github.com/wmo-im/bufr2geojson"
},
"split_keywords": [
"wmo",
"bufr",
"csv",
"encoding",
"weather",
"observations"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cb3e8ad46a0da507452bbbbdb019322810eed6326033502715a726827518bdd7",
"md5": "ee5941595b673eb188e0ed9b054ea989",
"sha256": "5646cb26fd7790ce9c61c9283196c4f70548d5d1d2306737a7554f39a8e6cdfe"
},
"downloads": -1,
"filename": "bufr2geojson-0.6.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "ee5941595b673eb188e0ed9b054ea989",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 18438,
"upload_time": "2024-05-06T00:04:39",
"upload_time_iso_8601": "2024-05-06T00:04:39.416016Z",
"url": "https://files.pythonhosted.org/packages/cb/3e/8ad46a0da507452bbbbdb019322810eed6326033502715a726827518bdd7/bufr2geojson-0.6.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cadcaa5aa8951f2d13c8317afb1718544748eef26c548160b4e534049d9f1cec",
"md5": "6904ee1974a5ae16d5543256c6861bcf",
"sha256": "a7b4cf004900f00adc65bb571e17a18be50b0fc714656e0341cf487f399661a2"
},
"downloads": -1,
"filename": "bufr2geojson-0.6.0.tar.gz",
"has_sig": false,
"md5_digest": "6904ee1974a5ae16d5543256c6861bcf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 19527,
"upload_time": "2024-05-06T00:04:41",
"upload_time_iso_8601": "2024-05-06T00:04:41.543988Z",
"url": "https://files.pythonhosted.org/packages/ca/dc/aa5aa8951f2d13c8317afb1718544748eef26c548160b4e534049d9f1cec/bufr2geojson-0.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-06 00:04:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "wmo-im",
"github_project": "bufr2geojson",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "bufr2geojson"
}