# veranda
[](https://travis-ci.org/TUW-GEO/veranda)
[](https://coveralls.io/github/TUW-GEO/veranda?branch=master)
[](https://badge.fury.io/py/veranda)
[](https://veranda.readthedocs.io/en/latest/?badge=latest)
[](https://opensource.org/licenses/MIT)
## Description
*veranda* stands for *"vector and raster data access"* and is a place for IO related classes and operations dealing
with raster and vector data. Besides bridging the gap between rigid and complex packages like GDAL to increase
user-friendliness and flexibility (similar to *rasterio*) it defines common ground to unite the world of raster and
vector data and harmonise the entry point to access different data formats or multiple files.
*veranda* consist of two modules *raster* and *vector* each containing the submodules *native* and *mosaic*. *native*
contains several classes for interacting with one file/data format, e.g. GeoTIFF or NetCDF. On the other hand, the
*mosaic* module offers a datacube-like interface to work with multiple, structured files, which can be distributed based on a
mosaic/grid in space or along a stack dimension, e.g. time, atmospheric layers, etc.
For further details we recommend to look at *veranda*'s documentation or tests.
## Installation
The package can be either installed via pip or if you want to contribute, we recommend to
install it as a conda environment.
### pip
To install *veranda* via pip in your own environment, use:
```
pip install veranda
```
**ATTENTION**: GDAL needs more OS support and has more dependencies then other packages and can therefore not be installed solely via pip.
Please have a look at https://pypi.org/project/GDAL/ what requirements are needed. Thus, for a fresh setup, an existing environment
with working a GDAL installation is expected.
### conda
The packages also comes along with one conda environment ``conda_environment.yml``.
This is especially recommended if you want to contribute to the project.
The following script will install miniconda and setup the environment on a UNIX
like system. Miniconda will be installed into ``$HOME/miniconda``.
```
wget http://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -O miniconda.sh
bash miniconda.sh -b -p $HOME/miniconda
export PATH="$HOME/miniconda/bin:$PATH"
conda env create -f conda_environment.yml
source activate veranda
```
This script adds ``$HOME/miniconda/bin`` temporarily to the ``PATH`` to do this
permanently add ``export PATH="$HOME/miniconda/bin:$PATH"`` to your ``.bashrc``
or ``.zshrc``.
For Windows, use the following setup:
* Download the latest [miniconda 3 installer](https://docs.conda.io/en/latest/miniconda.html) for Windows
* Click on ``.exe`` file and complete the installation.
* Add the folder ``condabin`` folder to your environment variable ``PATH``.
You can find the ``condabin`` folder usually under: ``C:\Users\username\AppData\Local\Continuum\miniconda3\condabin``
* Finally, you can set up the conda environment via:
```
conda env create -f conda_environment.yml
source activate veranda
```
After that you should be able to run
```
python setup.py test
```
to run the test suite.
## Contribution
We are happy if you want to contribute. Please raise an issue explaining what
is missing or if you find a bug. We will also gladly accept pull requests
against our master branch for new features or bug fixes.
If you want to contribute please follow these steps:
* Fork the *veranda* repository to your account
* Clone the *veranda* repository
* Make a new feature branch from the *veranda* master branch
* Add your feature
* Please include tests for your contributions in one of the test directories.
We use *py.test* so a simple function called ``test_my_feature`` is enough
* Submit a pull request to our master branch
## Outlook
The next major release will contain significant support for vector data including IO for SHP and LASZ files.
In addition the *raster* module will be extended to allow for accessing ZARR or HDF data for performant time series queries.
## Citation
If you use this software in a publication then please cite it using the Zenodo DOI.
## Note
This project has been set up using PyScaffold 3.2.2. For details and usage
information on PyScaffold see https://pyscaffold.org/.
Raw data
{
"_id": null,
"home_page": "https://github.com/TUW-GEO/veranda",
"name": "veranda",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "Earth Observation,Remote Sensing,IO,Data Cube",
"author": "Research Unit Remote Sensing at GEO Department",
"author_email": "remote.sensing@geo.tuwien.ac.at",
"download_url": "https://files.pythonhosted.org/packages/b2/86/b5d9a13731d52be35defe8fdc6fa2c63a1f29b349acbc4cd30567d39af07/veranda-1.1.0.tar.gz",
"platform": "any",
"description": "# veranda\n[](https://travis-ci.org/TUW-GEO/veranda)\n[](https://coveralls.io/github/TUW-GEO/veranda?branch=master)\n[](https://badge.fury.io/py/veranda)\n[](https://veranda.readthedocs.io/en/latest/?badge=latest)\n[](https://opensource.org/licenses/MIT)\n\n## Description\n*veranda* stands for *\"vector and raster data access\"* and is a place for IO related classes and operations dealing \nwith raster and vector data. Besides bridging the gap between rigid and complex packages like GDAL to increase \nuser-friendliness and flexibility (similar to *rasterio*) it defines common ground to unite the world of raster and \nvector data and harmonise the entry point to access different data formats or multiple files.\n\n*veranda* consist of two modules *raster* and *vector* each containing the submodules *native* and *mosaic*. *native* \ncontains several classes for interacting with one file/data format, e.g. GeoTIFF or NetCDF. On the other hand, the \n*mosaic* module offers a datacube-like interface to work with multiple, structured files, which can be distributed based on a \nmosaic/grid in space or along a stack dimension, e.g. time, atmospheric layers, etc.\n\nFor further details we recommend to look at *veranda*'s documentation or tests. \n\n\n## Installation\nThe package can be either installed via pip or if you want to contribute, we recommend to \ninstall it as a conda environment.\n\n### pip\nTo install *veranda* via pip in your own environment, use:\n```\npip install veranda\n```\n**ATTENTION**: GDAL needs more OS support and has more dependencies then other packages and can therefore not be installed solely via pip.\nPlease have a look at https://pypi.org/project/GDAL/ what requirements are needed. Thus, for a fresh setup, an existing environment \nwith working a GDAL installation is expected.\n\n### conda\nThe packages also comes along with one conda environment ``conda_environment.yml``. \nThis is especially recommended if you want to contribute to the project.\nThe following script will install miniconda and setup the environment on a UNIX\nlike system. Miniconda will be installed into ``$HOME/miniconda``.\n```\nwget http://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -O miniconda.sh\nbash miniconda.sh -b -p $HOME/miniconda\nexport PATH=\"$HOME/miniconda/bin:$PATH\"\nconda env create -f conda_environment.yml\nsource activate veranda\n```\nThis script adds ``$HOME/miniconda/bin`` temporarily to the ``PATH`` to do this\npermanently add ``export PATH=\"$HOME/miniconda/bin:$PATH\"`` to your ``.bashrc``\nor ``.zshrc``.\n\nFor Windows, use the following setup:\n * Download the latest [miniconda 3 installer](https://docs.conda.io/en/latest/miniconda.html) for Windows\n * Click on ``.exe`` file and complete the installation.\n * Add the folder ``condabin`` folder to your environment variable ``PATH``. \n You can find the ``condabin`` folder usually under: ``C:\\Users\\username\\AppData\\Local\\Continuum\\miniconda3\\condabin``\n * Finally, you can set up the conda environment via:\n ```\n conda env create -f conda_environment.yml\n source activate veranda\n ```\n\nAfter that you should be able to run \n```\npython setup.py test\n```\nto run the test suite.\n\n\n## Contribution\n\nWe are happy if you want to contribute. Please raise an issue explaining what\nis missing or if you find a bug. We will also gladly accept pull requests\nagainst our master branch for new features or bug fixes.\nIf you want to contribute please follow these steps:\n\n * Fork the *veranda* repository to your account\n * Clone the *veranda* repository\n * Make a new feature branch from the *veranda* master branch\n * Add your feature\n * Please include tests for your contributions in one of the test directories.\n We use *py.test* so a simple function called ``test_my_feature`` is enough\n * Submit a pull request to our master branch\n\n## Outlook\nThe next major release will contain significant support for vector data including IO for SHP and LASZ files.\nIn addition the *raster* module will be extended to allow for accessing ZARR or HDF data for performant time series queries. \n\n## Citation\nIf you use this software in a publication then please cite it using the Zenodo DOI.\n\n## Note\nThis project has been set up using PyScaffold 3.2.2. For details and usage\ninformation on PyScaffold see https://pyscaffold.org/.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "veranda is a place for IO related classes and operations dealing with multi-dimensional vector and raster data.",
"version": "1.1.0",
"project_urls": {
"Homepage": "https://github.com/TUW-GEO/veranda"
},
"split_keywords": [
"earth observation",
"remote sensing",
"io",
"data cube"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6458c9cc92264a382fff06064c72f60bd54b85d961f5419557f29a7dbd50023a",
"md5": "8cb9a26e4931b24ab72be1785b8faa02",
"sha256": "9028fb31a9a900794dd09a75f0a67f1611064d5f554fa85a587f2bac7b333e6b"
},
"downloads": -1,
"filename": "veranda-1.1.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "8cb9a26e4931b24ab72be1785b8faa02",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 49992,
"upload_time": "2023-07-03T08:34:53",
"upload_time_iso_8601": "2023-07-03T08:34:53.165121Z",
"url": "https://files.pythonhosted.org/packages/64/58/c9cc92264a382fff06064c72f60bd54b85d961f5419557f29a7dbd50023a/veranda-1.1.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b286b5d9a13731d52be35defe8fdc6fa2c63a1f29b349acbc4cd30567d39af07",
"md5": "75617712013953c56949e6cb886bde16",
"sha256": "b8c6f88667f61300a56b888f9a59e61e6c9b07a1397b901e3782110971621fe9"
},
"downloads": -1,
"filename": "veranda-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "75617712013953c56949e6cb886bde16",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 150065,
"upload_time": "2023-07-03T08:34:54",
"upload_time_iso_8601": "2023-07-03T08:34:54.516083Z",
"url": "https://files.pythonhosted.org/packages/b2/86/b5d9a13731d52be35defe8fdc6fa2c63a1f29b349acbc4cd30567d39af07/veranda-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-03 08:34:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "TUW-GEO",
"github_project": "veranda",
"travis_ci": true,
"coveralls": true,
"github_actions": true,
"lcname": "veranda"
}
JSON
