<div align="center">
<a href="https://github.com/CNES/shareloc"><img src="docs/source/images/shareloc_picto.svg" alt="Shareloc" title="Shareloc" width="20%"></a>
<h4>Shareloc, a simple remote sensing geometric library</h4>
[![Python](https://img.shields.io/badge/python-v3.8+-blue.svg)](https://www.python.org/downloads/release/python-380/)
[![Contributions welcome](https://img.shields.io/badge/contributions-welcome-orange.svg)](CONTRIBUTING.md)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0/)
[![Documentation](https://readthedocs.org/projects/shareloc/badge/?version=latest)](https://shareloc.readthedocs.io/?badge=latest)
<p>
<a href="#overview">Overview</a> .
<a href="#why-shareloc">Why Shareloc</a> .
<a href="#quick-start">Quick Start</a> .
<a href="#documentation">Documentation</a> .
<a href="#contribution">Contribution</a> .
</p>
</div>
## Overview
Shareloc is an open source remote sensing geolocation library.
It performs image coordinates projections between sensor and ground and vice versa.
Shareloc handles RPC models and direct location grids.
<div align="center">
Direct localization at constant elevation | Direct localization on DEM
:-------------------------:|:-------------------------:
<img src="docs/source/images/shareloc_loc_ellipsoid.png" alt="drawing" width="300"/> | <img src="docs/source/images/shareloc_loc_dem.png" alt="drawing" width="300"/>
</div>
Shareloc main functions :
* Direct/inverse localization at constant elevation (ellipsoidal earth model).
* Direct localization on 2.5D DEM (w.r.t ellipsoid or geoid).
* Line of sight triangulation.
* Rectification grid creation.
* Rectification grid interpolation.
## Why Shareloc
Shareloc development has been motivated by the need of a full python component for CNES studies and the need of an underlying geometrical component for <a href="https://github.com/CNES/cars">CARS</a>.
## Quick start
### Installation
Shareloc can be installed in a [virtualenv](https://docs.python.org/3/library/venv) from Pypi repository:
```
python -m venv shareloc-venv
source shareloc-venv/bin/activate
pip install --upgrade pip
pip install shareloc
```
For developers, Shareloc can be installed from source in a [virtualenv](https://docs.python.org/3/library/venv) using the following commands:
```
git clone https://github.com/CNES/shareloc
cd shareloc
make install
source venv/bin/activate # to go in installed dev environment
```
Dependencies : **git**, **make**
### Import
To test the import of the library:
```
python3
>>> import shareloc
```
And go to [Getting started](https://shareloc.readthedocs.io/en/latest/getting_started.html) in [Shareloc Documentation](https://shareloc.readthedocs.io/) for an example.
## Documentation
Go to [Shareloc Main Documentation](https://shareloc.readthedocs.io/)
## Contribution
To do a bug report or a contribution, see the [**Contribution Guide**](CONTRIBUTING.md).
For project evolution, see [**Changelog**](CHANGELOG.md)
Raw data
{
"_id": null,
"home_page": "https://shareloc.readthedocs.io/",
"name": "shareloc",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "shareloc, cars, 3D, DEM, pandora, photogrammetry",
"author": "CNES",
"author_email": "cars@cnes.fr",
"download_url": "https://files.pythonhosted.org/packages/41/9d/7205be1f6c774c58277c8b9dcfdb95e44831df00b08561d0981bb7841950/shareloc-0.2.4.tar.gz",
"platform": "any",
"description": " \n<div align=\"center\">\n <a href=\"https://github.com/CNES/shareloc\"><img src=\"docs/source/images/shareloc_picto.svg\" alt=\"Shareloc\" title=\"Shareloc\" width=\"20%\"></a>\n\n<h4>Shareloc, a simple remote sensing geometric library</h4>\n\n[![Python](https://img.shields.io/badge/python-v3.8+-blue.svg)](https://www.python.org/downloads/release/python-380/)\n[![Contributions welcome](https://img.shields.io/badge/contributions-welcome-orange.svg)](CONTRIBUTING.md)\n[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0/)\n[![Documentation](https://readthedocs.org/projects/shareloc/badge/?version=latest)](https://shareloc.readthedocs.io/?badge=latest)\n\n<p>\n <a href=\"#overview\">Overview</a> .\n <a href=\"#why-shareloc\">Why Shareloc</a> .\n <a href=\"#quick-start\">Quick Start</a> .\n <a href=\"#documentation\">Documentation</a> .\n <a href=\"#contribution\">Contribution</a> .\n</p>\n</div>\n\n## Overview\n\nShareloc is an open source remote sensing geolocation library.\n\nIt performs image coordinates projections between sensor and ground and vice versa.\nShareloc handles RPC models and direct location grids.\n\n<div align=\"center\">\n\nDirect localization at constant elevation | Direct localization on DEM\n:-------------------------:|:-------------------------:\n<img src=\"docs/source/images/shareloc_loc_ellipsoid.png\" alt=\"drawing\" width=\"300\"/> | <img src=\"docs/source/images/shareloc_loc_dem.png\" alt=\"drawing\" width=\"300\"/>\n\n</div>\n\nShareloc main functions :\n\n * Direct/inverse localization at constant elevation (ellipsoidal earth model).\n * Direct localization on 2.5D DEM (w.r.t ellipsoid or geoid).\n * Line of sight triangulation.\n * Rectification grid creation.\n * Rectification grid interpolation.\n\n## Why Shareloc\n\nShareloc development has been motivated by the need of a full python component for CNES studies and the need of an underlying geometrical component for <a href=\"https://github.com/CNES/cars\">CARS</a>.\n\n\n## Quick start\n\n### Installation\n\nShareloc can be installed in a [virtualenv](https://docs.python.org/3/library/venv) from Pypi repository:\n\n```\npython -m venv shareloc-venv\nsource shareloc-venv/bin/activate\npip install --upgrade pip\npip install shareloc\n```\n\nFor developers, Shareloc can be installed from source in a [virtualenv](https://docs.python.org/3/library/venv) using the following commands:\n\n```\ngit clone https://github.com/CNES/shareloc\ncd shareloc\nmake install\nsource venv/bin/activate # to go in installed dev environment\n```\n\nDependencies : **git**, **make**\n\n### Import\n\nTo test the import of the library:\n\n```\npython3\n>>> import shareloc\n```\n\nAnd go to [Getting started](https://shareloc.readthedocs.io/en/latest/getting_started.html) in [Shareloc Documentation](https://shareloc.readthedocs.io/) for an example.\n\n\n## Documentation\n\nGo to [Shareloc Main Documentation](https://shareloc.readthedocs.io/)\n\n## Contribution\n\nTo do a bug report or a contribution, see the [**Contribution Guide**](CONTRIBUTING.md).\nFor project evolution, see [**Changelog**](CHANGELOG.md)\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "Simple geometry library",
"version": "0.2.4",
"project_urls": {
"Documentation": "https://shareloc.readthedocs.io/en/latest/",
"Homepage": "https://shareloc.readthedocs.io/",
"Source": "https://github.com/CNES/shareloc"
},
"split_keywords": [
"shareloc",
" cars",
" 3d",
" dem",
" pandora",
" photogrammetry"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "419d7205be1f6c774c58277c8b9dcfdb95e44831df00b08561d0981bb7841950",
"md5": "a3280d745a5f3fa80152bf1dabdbe349",
"sha256": "ea63b62b3df78b4695e043e2a14d0018d93ce09bbdebf8412369ed71680115c2"
},
"downloads": -1,
"filename": "shareloc-0.2.4.tar.gz",
"has_sig": false,
"md5_digest": "a3280d745a5f3fa80152bf1dabdbe349",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 33125647,
"upload_time": "2024-12-03T09:52:14",
"upload_time_iso_8601": "2024-12-03T09:52:14.619078Z",
"url": "https://files.pythonhosted.org/packages/41/9d/7205be1f6c774c58277c8b9dcfdb95e44831df00b08561d0981bb7841950/shareloc-0.2.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-03 09:52:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "CNES",
"github_project": "shareloc",
"travis_ci": false,
"coveralls": true,
"github_actions": false,
"tox": true,
"lcname": "shareloc"
}