| Name | digdem JSON |
| Version |
0.2.2
JSON |
| download |
| home_page | |
| Summary | Semi-automated modification of Digital Elevation Models |
| upload_time | 2024-01-10 17:37:55 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2024 Marc PERUZZETTO Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
dem
surface
interpolation
modification
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# digdem
- [Description](#description)
- [Installation](#installation)
- [Quick start](#quick-start)
## Description <a name="description"></a>
`digdem` package can be used to modify semi-automatically Digital Elevation Models (or any raster data) in specific regions, using a limited number of
control points and control profiles. It follows the following steps:
1. Create instance of `SurfMod` with initial DEM, and an array specifying where the DEM will be modified;
2. Generate controlling sections (typically longitudinal and transverse sections), and specify the new altitude of their intersections if any;
3. Add additional control points along the sections by specifying their altitude, and if needed additional control points located within the mask but not on the sections;
4. `digdem` then interpolates the new DEM within the mask by:
- Interpolating splines along each section
- Interpolating the new DEM with Radial Basis Functions, using points along the splines, points on the contour of the mask, and if applicable additional control points within the mask.
5. Plot the new topography
Note that `digdem` is still under development, thus only minimal documentation is available at the moment, and testing is underway.
Contributions are feedback are most welcome.
## Installation <a name="installation"></a>
To install `digdem` from GitHub or PyPi, you'll need to have `pip` installed on your computer. `digdem` is not yet available on `conda-forge`.
It is strongly recommended to install `digdem` in a virtual environnement dedicated to this package. This can be done with `virtualenv`
(see the documentation e.g. [here](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/)).
Create the environnement with :
```bash
python -m venv /path/to/myenv
```
and activate it, on Linux:
```bash
source /path/to/myenv/bin/activate
```
and on Windows:
```cmd.exe
\path\to\myenv\Scripts\activate
```
Alternatively, if you are more used to Anaconda :
```bash
conda create -n digdem pip
conda activate digdem
```
or equivalently with Mamba :
```bash
mamba create -n digdem pip
mamba activate digdem
```
Before installing with `pip`, make sure `pip`, `steuptools` and `wheel` are up to date
```
python -m pip install --upgrade pip setuptools wheel
```
### Latest stable realease from PyPi <a name="pypi-install"></a>
```
python -m pip install tilupy
```
### Development version on from GitHub <a name="source-install"></a>
Download the GithHub repository [here](https://github.com/marcperuz/digdem), or clone it with
```
git clone https://github.com/marcperuz/tilupy.git
```
Open a terminal in the created folder and type:
```
python -m pip install .
```
## Quick start <a name="quick-start"></a>
See jupyter notebooks in examples.
Raw data
{
"_id": null,
"home_page": "",
"name": "digdem",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "dem,surface,interpolation,modification",
"author": "",
"author_email": "Marc Peruzzetto <m.peruzzetto@brgm.fr>",
"download_url": "https://files.pythonhosted.org/packages/00/50/20ca122f2ac82ac388243f1a7f7a877afaaf817e5aff9a62a94b8f14a142/digdem-0.2.2.tar.gz",
"platform": null,
"description": "# digdem\n\n- [Description](#description)\n- [Installation](#installation)\n- [Quick start](#quick-start)\n \n## Description <a name=\"description\"></a>\n\n`digdem` package can be used to modify semi-automatically Digital Elevation Models (or any raster data) in specific regions, using a limited number of\ncontrol points and control profiles. It follows the following steps:\n\n1. Create instance of `SurfMod` with initial DEM, and an array specifying where the DEM will be modified;\n2. Generate controlling sections (typically longitudinal and transverse sections), and specify the new altitude of their intersections if any;\n3. Add additional control points along the sections by specifying their altitude, and if needed additional control points located within the mask but not on the sections;\n4. `digdem` then interpolates the new DEM within the mask by:\n - Interpolating splines along each section\n - Interpolating the new DEM with Radial Basis Functions, using points along the splines, points on the contour of the mask, and if applicable additional control points within the mask.\n5. Plot the new topography\n\nNote that `digdem` is still under development, thus only minimal documentation is available at the moment, and testing is underway.\nContributions are feedback are most welcome. \n\n## Installation <a name=\"installation\"></a>\n\nTo install `digdem` from GitHub or PyPi, you'll need to have `pip` installed on your computer. `digdem` is not yet available on `conda-forge`. \n\nIt is strongly recommended to install `digdem` in a virtual environnement dedicated to this package. This can be done with `virtualenv`\n(see the documentation e.g. [here](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/)).\nCreate the environnement with :\n\n```bash\npython -m venv /path/to/myenv\n```\n\nand activate it, on Linux:\n\n```bash\nsource /path/to/myenv/bin/activate\n```\n\nand on Windows:\n\n```cmd.exe\n\\path\\to\\myenv\\Scripts\\activate\n```\n\nAlternatively, if you are more used to Anaconda :\n\n```bash\nconda create -n digdem pip\nconda activate digdem\n```\n\nor equivalently with Mamba :\n\n```bash\nmamba create -n digdem pip\nmamba activate digdem\n```\n\nBefore installing with `pip`, make sure `pip`, `steuptools` and `wheel` are up to date\n\n```\npython -m pip install --upgrade pip setuptools wheel\n```\n\n### Latest stable realease from PyPi <a name=\"pypi-install\"></a>\n\n```\npython -m pip install tilupy\n```\n\n### Development version on from GitHub <a name=\"source-install\"></a>\n\nDownload the GithHub repository [here](https://github.com/marcperuz/digdem), or clone it with\n\n```\ngit clone https://github.com/marcperuz/tilupy.git\n```\n\nOpen a terminal in the created folder and type:\n\n```\npython -m pip install .\n```\n\n## Quick start <a name=\"quick-start\"></a>\n\nSee jupyter notebooks in examples.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Marc PERUZZETTO Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "Semi-automated modification of Digital Elevation Models",
"version": "0.2.2",
"project_urls": {
"Homepage": "https://github.com/marcperuz/digdem"
},
"split_keywords": [
"dem",
"surface",
"interpolation",
"modification"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6d0e274777ed79d1f7451885916acee74a84af9be189dae3a94b74aa42d79506",
"md5": "7ff994e726ca5e8afd7a30a3c5b58ad6",
"sha256": "dad93f2121444035e762a132aed10ba11fb416af4be650a2eed23282808a405a"
},
"downloads": -1,
"filename": "digdem-0.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7ff994e726ca5e8afd7a30a3c5b58ad6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 18303,
"upload_time": "2024-01-10T17:37:54",
"upload_time_iso_8601": "2024-01-10T17:37:54.020916Z",
"url": "https://files.pythonhosted.org/packages/6d/0e/274777ed79d1f7451885916acee74a84af9be189dae3a94b74aa42d79506/digdem-0.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "005020ca122f2ac82ac388243f1a7f7a877afaaf817e5aff9a62a94b8f14a142",
"md5": "76af95fb0c18de9d8b897e628d2fc2b8",
"sha256": "b160e031a27694375446117b2d9a3ce221744a7e6cf88f92519051a026d6f096"
},
"downloads": -1,
"filename": "digdem-0.2.2.tar.gz",
"has_sig": false,
"md5_digest": "76af95fb0c18de9d8b897e628d2fc2b8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 18802,
"upload_time": "2024-01-10T17:37:55",
"upload_time_iso_8601": "2024-01-10T17:37:55.214339Z",
"url": "https://files.pythonhosted.org/packages/00/50/20ca122f2ac82ac388243f1a7f7a877afaaf817e5aff9a62a94b8f14a142/digdem-0.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-10 17:37:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "marcperuz",
"github_project": "digdem",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "digdem"
}
