########
satindex
########
.. begin-inclusion-intro-marker-do-not-remove
This package calculates several indexes based on multiband satellite images.
.. end-inclusion-intro-marker-do-not-remove
.. begin-inclusion-usage-marker-do-not-remove
How to use
----------
.. code-block:: python
from satindex import SatelliteImage
from satindex import example_data_path
# load a rgbi geotif
img = SatelliteImage(example_data_path)
# save ndwi image to example_data/ndwi.tif
img.save_ndwi(example_data_path.with_name("ndwi.tif"))
# save ndvi image to example_data/ndvi.tif
img.save_ndvi(example_data_path.with_name("ndvi.tif"))
# get ndwi as numpy array
ndwi = img.ndwi
.. end-inclusion-usage-marker-do-not-remove
.. begin-inclusion-installation-marker-do-not-remove
Installation
------------
To install satindex, do:
.. code-block:: console
git clone https://gitlab.com/rwsdatalab/public/codebase/image/satindex.git
cd satindex
pip install .
Run tests (including coverage) with:
.. code-block:: console
pip install -r requirements-dev.txt
python setup.py test
.. end-inclusion-installation-marker-do-not-remove
Documentation
-------------
.. begin-inclusion-readme-marker-do-not-remove
Find the full documentation at https://rwsdatalab.gitlab.io/public/codebase/image/satindex
.. begin-inclusion-license-marker-do-not-remove
License
-------
Copyright (c) 2022, Rijkswaterstaat
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
.. end-inclusion-license-marker-do-not-remove
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/rwsdatalab/rwsdatalab/public/codebase/image/satindex",
"name": "satindex",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "satindex",
"author": "RWS Datalab",
"author_email": "datalab.codebase@rws.nl",
"download_url": "https://files.pythonhosted.org/packages/52/b4/666d19309edc3675050b1dc90eebae9174300ab0a6a3ac8bb05834d735a9/satindex-0.1.0.tar.gz",
"platform": null,
"description": "########\nsatindex\n########\n\n.. begin-inclusion-intro-marker-do-not-remove\n\nThis package calculates several indexes based on multiband satellite images.\n\n.. end-inclusion-intro-marker-do-not-remove\n\n\n.. begin-inclusion-usage-marker-do-not-remove\n\nHow to use\n----------\n\n.. code-block:: python\n\n from satindex import SatelliteImage\n from satindex import example_data_path\n\n # load a rgbi geotif\n img = SatelliteImage(example_data_path)\n\n # save ndwi image to example_data/ndwi.tif\n img.save_ndwi(example_data_path.with_name(\"ndwi.tif\"))\n\n # save ndvi image to example_data/ndvi.tif\n img.save_ndvi(example_data_path.with_name(\"ndvi.tif\"))\n\n # get ndwi as numpy array\n ndwi = img.ndwi\n\n.. end-inclusion-usage-marker-do-not-remove\n\n\n.. begin-inclusion-installation-marker-do-not-remove\n\nInstallation\n------------\n\nTo install satindex, do:\n\n.. code-block:: console\n\n git clone https://gitlab.com/rwsdatalab/public/codebase/image/satindex.git\n cd satindex\n pip install .\n\nRun tests (including coverage) with:\n\n.. code-block:: console\n\n pip install -r requirements-dev.txt\n python setup.py test\n\n.. end-inclusion-installation-marker-do-not-remove\n\n\nDocumentation\n-------------\n\n.. begin-inclusion-readme-marker-do-not-remove\n\nFind the full documentation at https://rwsdatalab.gitlab.io/public/codebase/image/satindex\n\n\n.. begin-inclusion-license-marker-do-not-remove\n\nLicense\n-------\n\nCopyright (c) 2022, Rijkswaterstaat\n\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\nhttp://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n\n\n\n.. end-inclusion-license-marker-do-not-remove\n\n\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "This package calculates several indexes based onn multiband satellite images.",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://gitlab.com/rwsdatalab/rwsdatalab/public/codebase/image/satindex"
},
"split_keywords": [
"satindex"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0e527f1ffb322c1ae02f9d5faa4bca8a714e4cffa90ff1e99bb3f9fe69d3324f",
"md5": "f8d713249a9a7157a9b6f03458a7453d",
"sha256": "c49b5fd3bcb1f639545271b2c3125417395b9659b02587cd3f755f486a7b68bf"
},
"downloads": -1,
"filename": "satindex-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f8d713249a9a7157a9b6f03458a7453d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 8878,
"upload_time": "2023-07-28T08:12:00",
"upload_time_iso_8601": "2023-07-28T08:12:00.481702Z",
"url": "https://files.pythonhosted.org/packages/0e/52/7f1ffb322c1ae02f9d5faa4bca8a714e4cffa90ff1e99bb3f9fe69d3324f/satindex-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "52b4666d19309edc3675050b1dc90eebae9174300ab0a6a3ac8bb05834d735a9",
"md5": "b326bc6ad752c22a7665cdb61ef26992",
"sha256": "d691361b18c16632511fc8259dbb0884c9f621e2c6272198562a5f9548a2d5fd"
},
"downloads": -1,
"filename": "satindex-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "b326bc6ad752c22a7665cdb61ef26992",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 9669,
"upload_time": "2023-07-28T08:12:02",
"upload_time_iso_8601": "2023-07-28T08:12:02.721236Z",
"url": "https://files.pythonhosted.org/packages/52/b4/666d19309edc3675050b1dc90eebae9174300ab0a6a3ac8bb05834d735a9/satindex-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-28 08:12:02",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "rwsdatalab",
"gitlab_project": "rwsdatalab",
"lcname": "satindex"
}
JSON