picanteo


Namepicanteo JSON
Version 0.1.0 PyPI version JSON
download
home_pagehttps://github.com/CNES/picanteo
SummaryPicanteo: CNES change detection framework for natural disaster response
upload_time2025-07-18 07:40:06
maintainerNone
docs_urlNone
authorCNES
requires_python>=3.9
licenseApache V2.0
keywords picanteo change detection remote sensing
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <div align="center">
    <img src="docs/images/logo_with_text.png" width=500>

**Picanteo: CNES change detection framework for natural disaster response**

[![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)
[![pypi](https://img.shields.io/pypi/v/picanteo?color=%2334D058&label=pypi)](https://pypi.org/project/picanteo/)
</div>
 
# 🌶️ Overview

**Picanteo** is a flexible and modular framework developed by CNES for building custom change detection pipelines. It provides a set of tools in the `picanteo/toolbox` module, allowing users to create tailored pipelines or integrate their own tools to extend functionality.  
Whether you're analyzing satellite imagery or other geospatial data, **Picanteo** simplifies the process of detecting changes in dynamic environments.
<div align="center">
    <img src="docs/images/picanteo_visualize.png" width=1024>
</div>   


# ✨ Features
- **Modular Pipeline Design**: Easily construct and customize change detection pipelines using predefined or user-developed tools.
- **Extensible Toolbox**: Integrate your own tools into the `picanteo/toolbox` for enhanced flexibility.
- **Configuration-Driven**: Define pipelines using simple YAML configuration files.
- **Open Source**: Licensed under the Apache 2.0 License, encouraging collaboration and contributions.

# 🚀 Quick Start

## 🛠️ Installation

Install **Picanteo** via pip:
```sh
pip install picanteo
```
### Requirements
- Python 3.9 or higher

Dependencies are automatically installed via pip.  
See [install_requires](setup.cfg) for details.

## ⚙️ Run **Picanteo**

1) To launch **Picanteo**, you need a YAML configuration file specifying the pipeline and its parameters. 
Template configurations are available in the `/conf/pipelines` directory.  
2) Create or modify a YAML configuration file (e.g., my_conf.yaml).

3) Once this file is created, simply run the following command:
```sh
picanteo my_conf.yaml
```

If you want to try the pipelines already available in **Picanteo**, you have to download the weights from our model with this [link](https://drive.google.com/uc?id=1n1olMUY3ycx48YRZ7ZG-ME63cNjnRBtc). Then you have to move those weights in a specific folder:
```sh
mv weights.ckpt docs/tutorials/data/weights/manet_cos1_weights.ckpt
```
Then you can run the following command to launch the bitemporal 2D/3D change detection pipeline demo:
```sh
picanteo conf/pipelines/bitemporal_2D3D_pipeline.yaml
```
And you can run the following command to try the bitemporal 2D change detection pipeline demo:
```sh
picanteo conf/pipelines/bitemporal_2D_pipeline.yaml
```
You can now see the results with the following command line:
```sh
picanteo_visualize conf/steps/visualization_conf.yaml
```
*Hint:  in case you just want to try one of the pipelines, you should edit the `visualization_conf.yaml` and remove the unused pipeline under the `pages` section.*

# 👨‍🏫 Tutorials

Learn how to use **Picanteo** with these step-by-step guides:
- [Creating Your Own Change Detection Pipeline](docs/tutorials/how_to_create_a_pipeline.ipynb): A Jupyter notebook tutorial for building custom pipelines.
- [Preparing Your Data](docs/tutorials/data_readiness.md): Instructions for formatting your data to work with **Picanteo**’s toolbox.

# ✒️ Credits
If you use **Picanteo** in your research, please cite the following paper:
```text
@INPROCEEDINGS{picanteo2024,
  author={Hümmer, Christian and Lallement, Dimitri and Youssefi, David},
  booktitle={IGARSS 2024 - 2024 IEEE International Geoscience and Remote Sensing Symposium}, 
  title={Uncertainty-Aware 2d/3d Change Detection for Natural Disaster Response}, 
  year={2024},
  pages={3796-3801},
  doi={10.1109/IGARSS53475.2024.10642271}
}
```
# 📜 License

**Picanteo**  is licensed under Apache License v2.0. Please refer to the [LICENSE](LICENSE) file for more details.

# 🆘 Support

For issues, questions, or feature requests, please open an issue on our [GitHub Issues page](https://github.com/CNES/picanteo/issues) or check the documentation for additional resources.


# 🤝Contributing
We welcome contributions! Please read our [Contributing Guidelines](CONTRIBUTING.md) for details on how to get involved, including coding standards and submission processes.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/CNES/picanteo",
    "name": "picanteo",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "picanteo, Change detection, Remote Sensing",
    "author": "CNES",
    "author_email": "cars@cnes.fr",
    "download_url": "https://files.pythonhosted.org/packages/d0/d5/204ef6bf8f41a6ea996bb6515ce5c6e0dcc1d346c0369834bd3ebcfdb590/picanteo-0.1.0.tar.gz",
    "platform": null,
    "description": "<div align=\"center\">\n    <img src=\"docs/images/logo_with_text.png\" width=500>\n\n**Picanteo: CNES change detection framework for natural disaster response**\n\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[![pypi](https://img.shields.io/pypi/v/picanteo?color=%2334D058&label=pypi)](https://pypi.org/project/picanteo/)\n</div>\n \n# \ud83c\udf36\ufe0f Overview\n\n**Picanteo** is a flexible and modular framework developed by CNES for building custom change detection pipelines. It provides a set of tools in the `picanteo/toolbox` module, allowing users to create tailored pipelines or integrate their own tools to extend functionality.  \nWhether you're analyzing satellite imagery or other geospatial data, **Picanteo** simplifies the process of detecting changes in dynamic environments.\n<div align=\"center\">\n    <img src=\"docs/images/picanteo_visualize.png\" width=1024>\n</div>   \n\n\n# \u2728 Features\n- **Modular Pipeline Design**: Easily construct and customize change detection pipelines using predefined or user-developed tools.\n- **Extensible Toolbox**: Integrate your own tools into the `picanteo/toolbox` for enhanced flexibility.\n- **Configuration-Driven**: Define pipelines using simple YAML configuration files.\n- **Open Source**: Licensed under the Apache 2.0 License, encouraging collaboration and contributions.\n\n# \ud83d\ude80 Quick Start\n\n## \ud83d\udee0\ufe0f Installation\n\nInstall **Picanteo** via pip:\n```sh\npip install picanteo\n```\n### Requirements\n- Python 3.9 or higher\n\nDependencies are automatically installed via pip.  \nSee [install_requires](setup.cfg) for details.\n\n## \u2699\ufe0f Run **Picanteo**\n\n1) To launch **Picanteo**, you need a YAML configuration file specifying the pipeline and its parameters. \nTemplate configurations are available in the `/conf/pipelines` directory.  \n2) Create or modify a YAML configuration file (e.g., my_conf.yaml).\n\n3) Once this file is created, simply run the following command:\n```sh\npicanteo my_conf.yaml\n```\n\nIf you want to try the pipelines already available in **Picanteo**, you have to download the weights from our model with this [link](https://drive.google.com/uc?id=1n1olMUY3ycx48YRZ7ZG-ME63cNjnRBtc). Then you have to move those weights in a specific folder:\n```sh\nmv weights.ckpt docs/tutorials/data/weights/manet_cos1_weights.ckpt\n```\nThen you can run the following command to launch the bitemporal 2D/3D change detection pipeline demo:\n```sh\npicanteo conf/pipelines/bitemporal_2D3D_pipeline.yaml\n```\nAnd you can run the following command to try the bitemporal 2D change detection pipeline demo:\n```sh\npicanteo conf/pipelines/bitemporal_2D_pipeline.yaml\n```\nYou can now see the results with the following command line:\n```sh\npicanteo_visualize conf/steps/visualization_conf.yaml\n```\n*Hint:  in case you just want to try one of the pipelines, you should edit the `visualization_conf.yaml` and remove the unused pipeline under the `pages` section.*\n\n# \ud83d\udc68\u200d\ud83c\udfeb Tutorials\n\nLearn how to use **Picanteo** with these step-by-step guides:\n- [Creating Your Own Change Detection Pipeline](docs/tutorials/how_to_create_a_pipeline.ipynb): A Jupyter notebook tutorial for building custom pipelines.\n- [Preparing Your Data](docs/tutorials/data_readiness.md): Instructions for formatting your data to work with **Picanteo**\u2019s toolbox.\n\n# \u2712\ufe0f Credits\nIf you use **Picanteo** in your research, please cite the following paper:\n```text\n@INPROCEEDINGS{picanteo2024,\n  author={H\u00fcmmer, Christian and Lallement, Dimitri and Youssefi, David},\n  booktitle={IGARSS 2024 - 2024 IEEE International Geoscience and Remote Sensing Symposium}, \n  title={Uncertainty-Aware 2d/3d Change Detection for Natural Disaster Response}, \n  year={2024},\n  pages={3796-3801},\n  doi={10.1109/IGARSS53475.2024.10642271}\n}\n```\n# \ud83d\udcdc License\n\n**Picanteo**  is licensed under Apache License v2.0. Please refer to the [LICENSE](LICENSE) file for more details.\n\n# \ud83c\udd98 Support\n\nFor issues, questions, or feature requests, please open an issue on our [GitHub Issues page](https://github.com/CNES/picanteo/issues) or check the documentation for additional resources.\n\n\n# \ud83e\udd1dContributing\nWe welcome contributions! Please read our [Contributing Guidelines](CONTRIBUTING.md) for details on how to get involved, including coding standards and submission processes.\n",
    "bugtrack_url": null,
    "license": "Apache V2.0",
    "summary": "Picanteo: CNES change detection framework for natural disaster response",
    "version": "0.1.0",
    "project_urls": {
        "Homepage": "https://github.com/CNES/picanteo"
    },
    "split_keywords": [
        "picanteo",
        " change detection",
        " remote sensing"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "d0d5204ef6bf8f41a6ea996bb6515ce5c6e0dcc1d346c0369834bd3ebcfdb590",
                "md5": "bd4ea617f9ce557f92e7b0f5901ce4fa",
                "sha256": "3b51e85a2deab15d2c284b53d8c25716d61741e7fef0ed490b753476ce0bd92c"
            },
            "downloads": -1,
            "filename": "picanteo-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "bd4ea617f9ce557f92e7b0f5901ce4fa",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 46204,
            "upload_time": "2025-07-18T07:40:06",
            "upload_time_iso_8601": "2025-07-18T07:40:06.534339Z",
            "url": "https://files.pythonhosted.org/packages/d0/d5/204ef6bf8f41a6ea996bb6515ce5c6e0dcc1d346c0369834bd3ebcfdb590/picanteo-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-18 07:40:06",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "CNES",
    "github_project": "picanteo",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "picanteo"
}
        
Elapsed time: 1.14173s