<div align="center">
<a href="https://github.com/CNES/demcompare"><img src="docs/source/images/demcompare_picto.png" alt="Demcompare" title="Demcompare" width="200" align="center"></a>
<h4 align="center">Demcompare, a DEM comparison tool </h4>
[](https://www.python.org/downloads/release/python-380/)
[](https://demcompare.readthedocs.io/en/latest/developer_guide/contributing.html)
[](https://opensource.org/licenses/Apache-2.0/)
[](https://demcompare.readthedocs.io/)
<p align="center">
<a href="#overview">Overview</a> •
<a href="#install">Install</a> •
<a href="#usage">Usage</a> •
<a href="#documentation">Documentation</a> •
</p>
</div>
## Overview
Demcompare is a python software that aims at **comparing two DEMs** together.
A DEM is a 3D computer graphics representation of elevation data to represent terrain.
**Demcompare** has several characteristics:
* Works whether or not the two DEMs share common format projection system, planimetric resolution, and altimetric unit.
* Performs the coregistration based on the Nuth & Kääb universal coregistration method.
* Offers two coregistration modes to choose which of both DEMs is to be adapted during coregistration.
* Provides a wide variety of standard metrics which can be classified.
* Classifies the stats by slope ranges by default, but one can provide any other data to classify the stats.
## Install
Only **Linux Plaforms** are supported (virtualenv or bare machine) with **Python >= 3.8** installed.
Demcompare is available on Pypi and can be typically installed through a [virtualenv](https://docs.python.org/3/library/venv):
```
python3 -m venv venv
source venv/bin/activate
pip install --upgrade pip
pip install demcompare
```
## Usage
Download the data samples and run the python script **demcompare** with sample configuration:
```bash
# download data samples
wget https://raw.githubusercontent.com/CNES/demcompare/master/data_samples/srtm_blurred_and_shifted.tif
wget https://raw.githubusercontent.com/CNES/demcompare/master/data_samples/srtm_ref.tif
# download demcompare predefined configuration
wget https://raw.githubusercontent.com/CNES/demcompare/master/data_samples/sample_config.json
# run demcompare
demcompare sample_config.json
```
A report can be observed with:
```
firefox test_output/report/published_report/html/index.html
```
## Documentation
Please consult [our online documentation](https://demcompare.readthedocs.io).
## Licensing
Demcompare software is distributed under the Apache Software License (ASL) v2.0.
See [LICENSE](./LICENSE) file or <http://www.apache.org/licenses/LICENSE-2.0> for details.
Copyrights and authoring can be found in [NOTICE](./NOTICE) file.
## Related tools
[CARS](https://github.com/CNES/CARS) - CNES 3D reconstruction software
[Pandora](https://github.com/CNES/pandora) - CNES Stereo Matching framework
Raw data
{
"_id": null,
"home_page": "https://github.com/CNES/demcompare",
"name": "demcompare",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "demcompare,3D,DEM,cars,pandora,photogrammetry",
"author": "CNES",
"author_email": "cars@cnes.fr",
"download_url": "https://files.pythonhosted.org/packages/cf/6c/8a1b78586f39737541d201c12f0fea8c24881e6a3feb1f1f2371dc82b184/demcompare-0.5.2.tar.gz",
"platform": "any",
"description": "<div align=\"center\">\n <a href=\"https://github.com/CNES/demcompare\"><img src=\"docs/source/images/demcompare_picto.png\" alt=\"Demcompare\" title=\"Demcompare\" width=\"200\" align=\"center\"></a>\n\n<h4 align=\"center\">Demcompare, a DEM comparison tool </h4>\n\n[](https://www.python.org/downloads/release/python-380/)\n[](https://demcompare.readthedocs.io/en/latest/developer_guide/contributing.html)\n[](https://opensource.org/licenses/Apache-2.0/)\n[](https://demcompare.readthedocs.io/)\n\n<p align=\"center\">\n <a href=\"#overview\">Overview</a> \u2022\n <a href=\"#install\">Install</a> \u2022\n <a href=\"#usage\">Usage</a> \u2022\n <a href=\"#documentation\">Documentation</a> \u2022\n</p>\n</div>\n\n## Overview\n\nDemcompare is a python software that aims at **comparing two DEMs** together.\n\nA DEM is a 3D computer graphics representation of elevation data to represent terrain.\n\n**Demcompare** has several characteristics:\n\n* Works whether or not the two DEMs share common format projection system, planimetric resolution, and altimetric unit.\n* Performs the coregistration based on the Nuth & K\u00e4\u00e4b universal coregistration method.\n* Offers two coregistration modes to choose which of both DEMs is to be adapted during coregistration.\n* Provides a wide variety of standard metrics which can be classified.\n* Classifies the stats by slope ranges by default, but one can provide any other data to classify the stats.\n\n## Install\n\nOnly **Linux Plaforms** are supported (virtualenv or bare machine) with **Python >= 3.8** installed.\n\nDemcompare is available on Pypi and can be typically installed through a [virtualenv](https://docs.python.org/3/library/venv):\n\n```\npython3 -m venv venv\nsource venv/bin/activate\npip install --upgrade pip\npip install demcompare\n```\n\n## Usage\n\nDownload the data samples and run the python script **demcompare** with sample configuration:\n\n```bash\n# download data samples\nwget https://raw.githubusercontent.com/CNES/demcompare/master/data_samples/srtm_blurred_and_shifted.tif\nwget https://raw.githubusercontent.com/CNES/demcompare/master/data_samples/srtm_ref.tif\n\n# download demcompare predefined configuration\nwget https://raw.githubusercontent.com/CNES/demcompare/master/data_samples/sample_config.json\n\n# run demcompare\ndemcompare sample_config.json\n```\n\nA report can be observed with:\n\n```\nfirefox test_output/report/published_report/html/index.html\n```\n\n## Documentation\n\nPlease consult [our online documentation](https://demcompare.readthedocs.io).\n\n## Licensing\n\nDemcompare software is distributed under the Apache Software License (ASL) v2.0.\n\nSee [LICENSE](./LICENSE) file or <http://www.apache.org/licenses/LICENSE-2.0> for details.\n\nCopyrights and authoring can be found in [NOTICE](./NOTICE) file.\n\n## Related tools\n\n[CARS](https://github.com/CNES/CARS) - CNES 3D reconstruction software\n\n[Pandora](https://github.com/CNES/pandora) - CNES Stereo Matching framework\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "A tool to compare Digital Elevation Models",
"version": "0.5.2",
"project_urls": {
"Homepage": "https://github.com/CNES/demcompare"
},
"split_keywords": [
"demcompare",
"3d",
"dem",
"cars",
"pandora",
"photogrammetry"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7a922dc3b3f8f021b3486ae9db79396fd0a993cd2dc7ac28719171787295de67",
"md5": "afcf8cb8f892bfbac820127dbc50dadc",
"sha256": "664e7a343a918df0f870427b9d00ffa442e5bcc7b1a7c6d76e26791233b1af43"
},
"downloads": -1,
"filename": "demcompare-0.5.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "afcf8cb8f892bfbac820127dbc50dadc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 3974869,
"upload_time": "2023-05-31T22:08:03",
"upload_time_iso_8601": "2023-05-31T22:08:03.730349Z",
"url": "https://files.pythonhosted.org/packages/7a/92/2dc3b3f8f021b3486ae9db79396fd0a993cd2dc7ac28719171787295de67/demcompare-0.5.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cf6c8a1b78586f39737541d201c12f0fea8c24881e6a3feb1f1f2371dc82b184",
"md5": "fdae3546434b0c5626826ced7cd79c40",
"sha256": "17d0348c78748b22652a713278660bf5cf6ee6425450eef1cae0e1fd47a7b572"
},
"downloads": -1,
"filename": "demcompare-0.5.2.tar.gz",
"has_sig": false,
"md5_digest": "fdae3546434b0c5626826ced7cd79c40",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 67349056,
"upload_time": "2023-05-31T22:09:39",
"upload_time_iso_8601": "2023-05-31T22:09:39.782583Z",
"url": "https://files.pythonhosted.org/packages/cf/6c/8a1b78586f39737541d201c12f0fea8c24881e6a3feb1f1f2371dc82b184/demcompare-0.5.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-31 22:09:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "CNES",
"github_project": "demcompare",
"travis_ci": false,
"coveralls": true,
"github_actions": false,
"tox": true,
"lcname": "demcompare"
}
JSON
