cars 1.0.0rc1__cp312-cp312-manylinux_2_17_i686.manylinux2014_i686.whl

cars/starter.py

@@ -0,0 +1,167 @@
+#!/usr/bin/env python
+# coding: utf8
+#
+# Copyright (c) 2020 Centre National d'Etudes Spatiales (CNES).
+#
+# This file is part of CARS
+# (see https://github.com/CNES/cars).
+#
+# 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.
+#
+"""
+cars-starter: helper to create configuration file
+"""
+
+# pylint: disable=import-outside-toplevel
+# standard imports
+import argparse
+import json
+import os
+
+import yaml
+
+
+def inputfilename_to_sensor(inputfilename):
+    """
+    Fill sensor dictionary according to an input filename
+    """
+    sensor = {}
+
+    absfilename = os.path.abspath(inputfilename)
+    dirname = os.path.dirname(absfilename)
+    basename = os.path.basename(absfilename)
+
+    if basename.startswith("DIM") and basename.endswith("XML"):
+        geomodel = os.path.join(dirname, "RPC" + basename[3:])
+        if os.path.exists(geomodel) is False:
+            geomodel = None
+
+    elif basename.endswith(".tif"):
+        geomodel = os.path.splitext(absfilename)[0] + ".geom"
+        if os.path.exists(geomodel) is False:
+            geomodel = None
+    else:
+        raise ValueError(absfilename + " not supported")
+
+    sensor["image"] = absfilename
+    if geomodel is not None:
+        sensor["geomodel"] = geomodel
+
+    return sensor
+
+
+def cars_starter(cli_params: dict = None, **kwargs) -> None:
+    """
+    Main fonction. Expects a dictionary from the CLI (cli_params)
+    or directly the input parameters.
+    """
+    if cli_params and isinstance(cli_params, dict):
+        config = cli_params
+    else:
+        params_name = set(kwargs.keys())
+        required_params = {"il", "out"}
+        missing_params = required_params - params_name
+        if len(missing_params) > 0:
+            raise ValueError(
+                "The following parameters are required: {}".format(
+                    ", ".join(list(missing_params))
+                )
+            )
+        config = kwargs
+
+    cars_config = {"input": {"sensors": {}}, "output": {}}
+    pipeline_name = "default"
+
+    for idx, inputfilename in enumerate(config["il"]):
+        cars_config["input"]["sensors"][str(idx)] = inputfilename_to_sensor(
+            inputfilename
+        )
+
+    # pairing with first image as reference
+    pairing = list(
+        zip(  # noqa: B905
+            ["0"] * (len(config["il"]) - 1),
+            map(str, range(1, len(config["il"]))),
+        )
+    )
+
+    cars_config["input"]["pairing"] = pairing
+    cars_config["output"]["directory"] = config["out"]
+
+    check = config["check"] if "check" in config.keys() else False
+    full = config["full"] if "full" in config.keys() else False
+
+    if check or full:
+        # cars imports
+        from cars.pipelines.pipeline import Pipeline
+
+        used_pipeline = Pipeline(pipeline_name, cars_config, None)
+        if full:
+            cars_config = used_pipeline.used_conf
+
+    # output format handling
+    output_format = config.get("format", "yaml")
+    if output_format == "yaml":
+        print(yaml.safe_dump(cars_config, sort_keys=False))
+    elif output_format == "json":
+        print(json.dumps(cars_config, indent=2))
+    else:
+        raise ValueError(
+            "Invalid format: {}. Use 'json' or 'yaml'.".format(output_format)
+        )
+
+
+def cli():
+    """
+    Main cars-starter entrypoint (Command Line Interface)
+    """
+    parser = argparse.ArgumentParser(
+        "cars-starter", description="Helper to create configuration file"
+    )
+    parser.add_argument(
+        "-il",
+        type=str,
+        nargs="*",
+        metavar="input.{tif,XML}",
+        help="Input sensor list",
+        required=True,
+    )
+
+    parser.add_argument(
+        "-out",
+        type=str,
+        metavar="out_dir",
+        help="Output directory",
+        required=True,
+    )
+
+    parser.add_argument(
+        "--full", action="store_true", help="Fill all default values"
+    )
+
+    parser.add_argument("--check", action="store_true", help="Check input")
+
+    parser.add_argument(
+        "--format",
+        type=str,
+        default="yaml",
+        choices=["json", "yaml"],
+        help="Output format (json or yaml). Default: yaml",
+    )
+
+    args = parser.parse_args()
+    cars_starter(vars(args))
+
+
+if __name__ == "__main__":
+    cli()

cars-1.0.0rc1.dist-info/METADATA

@@ -0,0 +1,292 @@
+Metadata-Version: 2.1
+Name: cars
+Version: 1.0.0rc1
+Summary: A satellite multi view stereo pipeline
+Keywords: cars,3D,DEM,pandora,photogrammetry
+Author-Email: CNES <cars@cnes.fr>
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Intended Audience :: Science/Research
+Classifier: Environment :: Console
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.9
+Project-URL: Documentation, https://cars.readthedocs.io/en/latest/
+Project-URL: Repository, https://github.com/CNES/cars
+Requires-Python: >=3.9
+Requires-Dist: numpy>=1.17.0
+Requires-Dist: scipy!=1.10.0,>=1.7.1
+Requires-Dist: matplotlib
+Requires-Dist: affine
+Requires-Dist: rasterio>=1.3.0
+Requires-Dist: dask>=2021.10.0
+Requires-Dist: distributed>=2021.10.0
+Requires-Dist: dask-jobqueue>=0.7.3
+Requires-Dist: json-checker
+Requires-Dist: pyyaml
+Requires-Dist: xarray
+Requires-Dist: tqdm
+Requires-Dist: netCDF4>=1.5.3
+Requires-Dist: Shapely
+Requires-Dist: Fiona
+Requires-Dist: pyproj
+Requires-Dist: utm
+Requires-Dist: pandas
+Requires-Dist: urllib3<2.0,>=1.21.1
+Requires-Dist: laspy[laszip]
+Requires-Dist: tbb==2020.3.254
+Requires-Dist: numba
+Requires-Dist: pandora[sgm]==1.7.2
+Requires-Dist: cars-rasterize==0.2.*
+Requires-Dist: cars-resample==0.1.*
+Requires-Dist: cars-filter==0.2.*
+Requires-Dist: vlsift==0.1.*
+Requires-Dist: shareloc==0.2.11
+Requires-Dist: bulldozer-dtm==1.1.*
+Requires-Dist: xdem==0.1.*
+Requires-Dist: geopandas<=1.0.1
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: pytest-check; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: isort>=5.8.0; extra == "dev"
+Requires-Dist: black>=24.1a1; extra == "dev"
+Requires-Dist: flake8>=3.9.1; extra == "dev"
+Requires-Dist: flake8-pyproject; extra == "dev"
+Requires-Dist: flake8-comprehensions>=3.4.0; extra == "dev"
+Requires-Dist: flake8-bugbear<24.0.0,>=21.4.3; extra == "dev"
+Requires-Dist: jupyter_contrib_nbextensions; extra == "dev"
+Requires-Dist: pylint<4.0.0,>=2.8.12; extra == "dev"
+Requires-Dist: setuptools_scm; extra == "dev"
+Requires-Dist: virtualenv; extra == "dev"
+Requires-Dist: configupdater; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Requires-Dist: notebook<7.0.0; extra == "dev"
+Requires-Dist: bokeh==2.4.3; extra == "dev"
+Requires-Dist: sphinx; extra == "dev"
+Requires-Dist: sphinx-rtd-theme; extra == "dev"
+Requires-Dist: graphviz; extra == "dev"
+Requires-Dist: memory_profiler; extra == "dev"
+Requires-Dist: memray; extra == "dev"
+Requires-Dist: dash; extra == "dev"
+Requires-Dist: plotly; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: astroid<4.0.0; extra == "docs"
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: sphinx-rtd-theme; extra == "docs"
+Requires-Dist: sphinx_autoapi; extra == "docs"
+Requires-Dist: graphviz; extra == "docs"
+Requires-Dist: sphinx_tabs; extra == "docs"
+Requires-Dist: sphinx-copybutton; extra == "docs"
+Provides-Extra: notebook
+Requires-Dist: notebook; extra == "notebook"
+Requires-Dist: bokeh; extra == "notebook"
+Requires-Dist: rise; extra == "notebook"
+Provides-Extra: pandora-mccnn
+Requires-Dist: pandora_plugin_mccnn==1.3.5; extra == "pandora-mccnn"
+Provides-Extra: bundleadjustment
+Requires-Dist: rpcfit; extra == "bundleadjustment"
+Description-Content-Type: text/markdown
+
+<div align="center">
+<a target="_blank" href="https://github.com/CNES/cars">
+<picture>
+  <img
+    src="https://raw.githubusercontent.com/CNES/cars/master/docs/source/images/cars_picto.svg"
+    alt="CARS"
+    width="50%"
+  />
+</picture>
+</a>
+
+<h4>CARS, a satellite multi view stereo framework </h4>
+
+[![Python](https://img.shields.io/badge/python-v3.10+-blue.svg)](https://www.python.org/downloads/release/python-390/)
+[![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/cars/badge/?version=latest)](https://cars.readthedocs.io/?badge=latest)
+[![Github Action](https://github.com/CNES/cars/actions/workflows/cars-ci.yml/badge.svg?branch=master)](https://github.com/CNES/cars/actions)
+[![pypi](https://badge.fury.io/py/cars.svg)](https://pypi.org/project/cars/)
+[![Docker pulls](https://img.shields.io/badge/dynamic/json?formatter=metric&color=blue&label=Docker%20pull&query=%24.pull_count&url=https://hub.docker.com/v2/repositories/cnes/cars)](https://hub.docker.com/r/cnes/cars)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.17406459.svg)](https://doi.org/10.5281/zenodo.17406459)
+
+<p>
+  <a href="#overview">Overview</a> •
+  <a href="#quick-start">Quick Start</a> •
+  <a href="#documentation">Documentation</a> •
+  <a href="#license">License</a> •
+  <a href="#contribution">Contribution</a> •
+  <a href="#help">Help</a> •
+  <a href="#credits">Credits</a> •
+  <a href="#contact">Contact</a> •
+  <a href="#references">References</a>
+</p>
+</div>
+
+# 🌐 **Overview**
+
+<div align="center">
+<table style="display: inline-block;">
+  <tr>
+    <td align="center">
+      <div  style="font-size:2em; margin-bottom:10px;"><strong>🎞️ From Stereo Images</strong></div><br>
+      <img src="https://raw.githubusercontent.com/CNES/cars/master/docs/source/images/animation_sat.gif"
+           alt="Stereo images animation" width="95%"><br>
+      <em>Input stereo image pairs</em>
+    </td>
+    <td align="center">
+      <div  style="font-size:2em; margin-bottom:10px;"><strong>🌍 To Digital Surface Model (DSM)</strong></div><br>
+      <img src="https://raw.githubusercontent.com/CNES/cars/master/docs/source/images/overview_dsm_3d.gif"
+           alt="DSM overview" width="95%"><br>
+      <em>Output 3D surface reconstruction</em>
+    </td>
+  </tr>
+</table>
+</div>
+
+**CARS** is an open source 3D tool dedicated to produce **Digital Surface Models** from satellite imaging by photogrammetry.
+This Multiview Stereo framework is intended for massive DSM production with a robust, performant and modular design.
+
+**CARS** is currently under active development and integrated into various projects & missions:
+
+<div align="center">
+<p align="center">
+  <a href="https://co3d.cnes.fr/en/co3d-0" target="_blank">
+    <img src="https://raw.githubusercontent.com/CNES/cars/master/docs/source/images/logo_co3D_cnes.png"
+         alt="CO3D project" height="70">
+  </a>
+  &nbsp;&nbsp;&nbsp;&nbsp;
+  <a href="https://www.ai4geo.eu" target="_blank">
+    <img src="https://raw.githubusercontent.com/CNES/cars/master/docs/source/images/logo-ai4geo.png"
+         alt="AI4GEO project" height="75">
+  </a>
+  &nbsp;&nbsp;&nbsp;&nbsp;
+  <a href="https://www.evo-land.eu" target="_blank">
+    <img src="https://raw.githubusercontent.com/CNES/cars/master/docs/source/images/logo-evoland.png"
+         alt="Evoland project" height="60">
+  </a>
+</p>
+</div>
+
+<br>
+
+Its roadmap and implemented functionalities are evolving regularly depending on specific project requirements.
+
+# 🚀 **Quick start**
+
+
+### △ On the way to the Pyramids...
+---
+
+You want to build the pyramids by yourself? 
+
+
+<div align="center">
+<table style="display: inline-block;">
+  <tr>
+    <td align="center">
+      <img src="https://raw.githubusercontent.com/CNES/cars/master/docs/source/images/dsm.png"
+           alt="Dsm" width="400"><br>
+    </td>
+    <td align="center">
+      <img src="https://raw.githubusercontent.com/CNES/cars/master/docs/source/images/clr.png"
+           alt="Color" width="400"><br>
+    </td>
+     <td align="center">
+      <img src="https://raw.githubusercontent.com/CNES/cars/master/docs/source/images/dsm_clr.png"
+           alt="Color" width="400"><br>
+    </td>
+  </tr>
+</table>
+</div>
+
+Download our [open licence](https://www.etalab.gouv.fr/licence-ouverte-open-licence) Pleiades [data sample](https://raw.githubusercontent.com/CNES/cars/master/tutorials/data_gizeh.tar.bz2) to give CARS a try!
+
+
+### 🐋 with Docker
+---
+
+#### 🛠 Installation
+
+CARS is available on Docker Hub and can be downloaded by:
+``` bash
+docker pull cnes/cars
+```
+
+#### ⚙ Run CARS
+
+You only need to launch one command:
+
+```
+docker run -w /data -v "$(pwd)"/data_gizeh:/data cnes/cars /data/configfile.yaml
+```
+
+### 🐍 with pip
+---
+
+#### 🛠 Installation
+
+CARS can also be downloaded using the pip install command:
+
+``` bash 
+pip install cars 
+```
+
+#### ⚙ Run CARS
+
+Once you moved to the data_gizeh directory:
+
+``` bash 
+cars configfile.yaml
+```
+
+# 📚 **Documentation**
+
+Go to [CARS Main Documentation](https://cars.readthedocs.io/?badge=latest).
+
+# 📜 **License**
+
+CARS is licensed under [Apache License v2.0](https://www.apache.org/licenses/LICENSE-2.0). Please refer to the [LICENSE](https://gitlab.cnes.fr/dali/cars-park/cars/-/blob/1214-mise-a-jour-du-readme-pour-la-nouvelle-version-1-0-0/LICENSE) file for more details.
+
+# 🤝 **Contribution**
+
+To do a contribution, see the [Contribution Guide](https://github.com/CNES/cars/blob/master/CONTRIBUTING.md).  For project evolution, see [Changelog](https://github.com/CNES/cars/blob/master/CHANGELOG.md).
+
+# 🆘 **Help**
+
+For issues, questions, or feature requests, please open an issue on our [GitHub Issues](https://github.com/CNES/cars/issues) page or check the [documentation](https://cars.readthedocs.io/en/stable/index.html) for additional resources.
+
+You can also ask your questions on the corresponding [slack](https://join.slack.com/t/cars-community/shared_invite/zt-2uw6usog1-~TT~m8BxO9faMXpP7tpz2Q).
+
+# ✒️ **Credits**
+
+If you use CARS in your research, please cite the following paper:
+
+```
+@INPROCEEDINGS{9324020,
+  author={Youssefi, David and Michel, Julien and Sarrazin, Emmanuelle and Buffe, Fabrice and Cournet, Myriam and Delvit, Jean-Marc and L'Helguen, Céline and Melet, Olivier and Emilien, Aurélie and Bosman, Julien},
+  booktitle={IGARSS 2020 - 2020 IEEE International Geoscience and Remote Sensing Symposium}, 
+  title={CARS: A Photogrammetry Pipeline Using Dask Graphs to Construct A Global 3D Model}, 
+  year={2020},
+  volume={},
+  number={},
+  pages={453-456},
+  keywords={Automobiles;Geometry;Three-dimensional displays;Computational modeling;Estimation;Stereo image processing;Task analysis;Image processing;Photogrammetry;Stereovision;Digital Surface Model;High Performance Computing;Cloud Computing;Dask},
+  doi={10.1109/IGARSS39084.2020.9324020}}
+```
+
+See [Authors file](https://github.com/CNES/cars/blob/master/AUTHORS.md)
+
+# ✉️ **Contact**
+
+You can contact us on the following mail adress: cars@cnes.fr
+
+# 🔗 **References**
+
+- [Youssefi D., Michel, J., Sarrazin, E., Buffe, F., Cournet, M., Delvit, J., L’Helguen, C., Melet, O., Emilien, A., Bosman, J., 2020. Cars: A photogrammetry pipeline using dask graphs to construct a global 3d model. IGARSS - IEEE International Geoscience and Remote Sensing Symposium.](https://ieeexplore.ieee.org/document/9324020)
+- [Michel, J., Sarrazin, E., Youssefi, D., Cournet, M., Buffe, F., Delvit, J., Emilien, A., Bosman, J., Melet, O., L’Helguen, C., 2020. A new satellite imagery stereo pipeline designed for scalability, robustness and performance. ISPRS - International Archives of the Photogrammetry, Remote Sensing and Spatial Information Sciences.](https://www.isprs-ann-photogramm-remote-sens-spatial-inf-sci.net/V-2-2020/171/2020/)