-
Notifications
You must be signed in to change notification settings - Fork 35
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
CARS: A new satellite imagery stereo pipeline
Designed for scalability, robustness and performance Co-authored-by: Julien Michel <[email protected]> Co-authored-by: Emmanuelle Sarrazin <[email protected]> Co-authored-by: Aurélie Emilien <[email protected]> Co-authored-by: Fabrice Buffe <[email protected]> Co-authored-by: Myriam Cournet <[email protected]> Co-authored-by: Julien Bosman <[email protected]> Co-authored-by: Guillaume Pasero <[email protected]> Co-authored-by: Emmanuel Dubois <[email protected]> Co-authored-by: Sara Teraitetia <[email protected]>
- Loading branch information
Showing
220 changed files
with
19,535 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
build/ | ||
*~ | ||
__pycache__/ | ||
.cache/ | ||
dask-worker-space/ | ||
.coverage* | ||
coverage.xml | ||
pytest-report.xml | ||
pylint-report.xml | ||
*.swp | ||
.ipynb_checkpoints/ | ||
*.pyc | ||
*.aux.xml |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
You'll find here the contributing guide of the **CARS** project. | ||
|
||
1. [Bug report](# Bug report) | ||
2. [Coding guide](# Coding guide) | ||
3. [Merge request acceptation process](# Merge request acceptation process) | ||
|
||
# Bug report | ||
|
||
Any proven or suspected malfunction should be traced in a bug report, the latter being an issue in the CARS github repository. Don't hesitate to do so: It is best to open a bug report and quickly resolve it than to let a problem remains in the project. | ||
|
||
In the problem description, be as accurate as possible. Include: | ||
* The procedure used to initialize the environment | ||
* The incriminated command line or python function | ||
* The content of the input and output configuration files (`content.json`) | ||
|
||
**Notifying the potential bugs is the first way for contributing to a software.** | ||
|
||
# Coding guide | ||
|
||
Here are some rules to apply when developing a new functionality: | ||
* Include a comments ratio high enough and use explicit variables names. A comment by code block of several lines is necessary to explain a new functionality. | ||
* The usage of the `print()` function is forbidden: use the `logging` python standard module instead. | ||
* If possible, limit the use of classes as much as possible and opt for a functional approach. The classes are reserved for data modelling if it is impossible to do so using `xarray`. | ||
* Each new functionality shall have a corresponding test in its module's test file. This test shall, if possible, check the function's outputs and the corresponding degraded cases. | ||
* All functions shall be documented (object, parameters, return values). | ||
* Factorize the code as much as possible. The command line tools shall only include the main workflow and rely on the cars python modules. | ||
* If major modifications of the user interface or of the tool's behaviour are done, update the user documentation (and the notebooks if necessary). | ||
* Do not add new dependencies unless it is absolutely necessary, and only if it has a permissive license. | ||
* Use the type hints provided by the `typing` python module. | ||
|
||
Any code modification requires a Merge Request. It is forbidden to push patches directly into master (this branch is protected). | ||
|
||
It is recommended to open your Merge Request as soon as possible in order to inform the developers of your ongoing work. | ||
Please add `WIP:` before your Merge Request title if your work is in progress: This prevents an accidental merge and informs the other developers of the unfinished state of your work. | ||
|
||
The Merge Request shall have a short description of the proposed changes. If it is relative to an issue, you can signal it by adding `Closes xx` where xx is the reference number of the issue. | ||
|
||
Likewise, if you work on a branch (which is recommended), prefix the branch's name by `xx-` in order to link it to the xx issue. | ||
|
||
# Merge request acceptation process | ||
|
||
The Merge Request will be merged into master after being review by a CARS steering committee (core committers) composed of: | ||
* David Youssefi (CNES DNO/OT/IS) | ||
* Emmanuelle Sarrazin (CNES DSO/SI/2A) | ||
* Julien Michel (CNES CESBIO) | ||
* Fabrice Buffe (CNES DSO/SI/QI) | ||
* Aurélie Emilien (CS Group) | ||
|
||
Only the members of this committee can merge into master. | ||
|
||
The checklist of a Merge Request acceptance is the following: | ||
* [ ] At least two code reviews have been done by members of the group above (who check among others the correct application of the rules listed in the [Coding guide](# Coding guide)). | ||
* [ ] All comments of the reviewers has been dealt with and are closed | ||
* [ ] The reviewers have signaled their approbation (thumb up) | ||
* [ ] No developer is against the Merge Request (thumb down) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,80 @@ | ||
FROM ubuntu:18.04 | ||
MAINTAINER David Youssefi <[email protected]> | ||
ARG DEBIAN_FRONTEND=noninteractive | ||
|
||
# standard packages | ||
RUN apt-get update && apt-get install -y \ | ||
cmake-curses-gui \ | ||
git \ | ||
libgl1 libglu1 libgl1-mesa-dev \ | ||
libsm6 libxext6 libxrender-dev \ | ||
python3 \ | ||
python3-pip \ | ||
python3-numpy \ | ||
wget \ | ||
&& rm -rf /var/lib/apt/lists/* | ||
|
||
# install orfeo toolbox | ||
WORKDIR /opt/otb | ||
RUN wget -nv https://www.orfeo-toolbox.org/packages/OTB-6aca6c3e-Linux64.run \ | ||
&& chmod +x OTB-6aca6c3e-Linux64.run \ | ||
&& ./OTB-6aca6c3e-Linux64.run --target /usr/local/otb \ | ||
&& /bin/bash -c 'source /usr/local/otb/otbenv.profile' \ | ||
&& ctest -S /usr/local/otb/share/otb/swig/build_wrapping.cmake -VV \ | ||
&& rm OTB-6aca6c3e-Linux64.run | ||
ENV LD_LIBRARY_PATH=/usr/local/otb/lib:$LD_LIBRARY_PATH \ | ||
OTB_APPLICATION_PATH=/usr/local/otb/lib/otb/applications:$OTB_APPLICATION_PATH \ | ||
PATH=/usr/local/otb/bin/:$PATH \ | ||
PYTHONPATH=/usr/local/otb/lib/python:$PYTHONPATH \ | ||
GDAL_DATA=/usr/local/otb/share/gdal \ | ||
GEOTIFF_CSV=/usr/local/otb/share/epsg_csv | ||
COPY gdal-config /usr/local/otb/bin/ | ||
|
||
# install vlfeat | ||
RUN cd /tmp \ | ||
&& git clone https://github.com/vlfeat/vlfeat.git vlfeat \ | ||
&& cd vlfeat \ | ||
&& make \ | ||
&& cp bin/glnxa64/libvl.so /usr/local/lib \ | ||
&& mkdir -p /usr/local/include/vl \ | ||
&& cp vl/*.h /usr/local/include/vl \ | ||
&& cd /tmp \ | ||
&& rm -rf vlfeat | ||
|
||
# copy | ||
COPY . /cars/ | ||
WORKDIR /cars | ||
COPY geoid /usr/local/geoid | ||
ENV OTB_GEOID_FILE=/usr/local/geoid/egm96.grd | ||
|
||
# install cars | ||
RUN python3 -m pip install six setuptools --upgrade | ||
RUN python3 -m pip install pygdal==$(gdal-config --version).* | ||
ENV VLFEAT_INCLUDE_DIR=/usr/local/include | ||
RUN python3 -m pip install /cars/. | ||
|
||
RUN ln -s /usr/bin/python3 /usr/bin/python | ||
|
||
# source /usr/local/bin/env_cars.sh | ||
ENV CARSPATH=/cars \ | ||
CARS_STATIC_CONFIGURATION=/usr/local \ | ||
OTB_APPLICATION_PATH=/usr/lib:/usr/local/lib:$OTB_APPLICATION_PATH \ | ||
LD_LIBRARY_PATH=/usr/local/lib:$LD_LIBRARY_PATH \ | ||
CARS_NB_WORKERS_PER_PBS_JOB=2 \ | ||
OMP_NUM_THREADS=4 \ | ||
OTB_MAX_RAM_HINT=2000 \ | ||
OTB_LOGGER_LEVEL=WARNING \ | ||
GDAL_CACHEMAX=128 \ | ||
ITK_GLOBAL_DEFAULT_NUMBER_OF_THREADS=1 \ | ||
CARS_TEST_TEMPORARY_DIR=/tmp \ | ||
CURL_CA_BUNDLE=/etc/ssl/certs/ca-certificates.crt | ||
|
||
ENV NUMBA_NUM_THREADS=$OMP_NUM_THREADS \ | ||
OPJ_NUM_THREADS=$OMP_NUM_THREADS \ | ||
GDAL_NUM_THREADS=$OMP_NUM_THREADS | ||
|
||
ENV OTB_MAX_RAM_HINT=1000 | ||
|
||
# launch cars | ||
ENTRYPOINT ["cars_cli"] | ||
CMD ["-h"] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,202 @@ | ||
|
||
Apache License | ||
Version 2.0, January 2004 | ||
http://www.apache.org/licenses/ | ||
|
||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION | ||
|
||
1. Definitions. | ||
|
||
"License" shall mean the terms and conditions for use, reproduction, | ||
and distribution as defined by Sections 1 through 9 of this document. | ||
|
||
"Licensor" shall mean the copyright owner or entity authorized by | ||
the copyright owner that is granting the License. | ||
|
||
"Legal Entity" shall mean the union of the acting entity and all | ||
other entities that control, are controlled by, or are under common | ||
control with that entity. For the purposes of this definition, | ||
"control" means (i) the power, direct or indirect, to cause the | ||
direction or management of such entity, whether by contract or | ||
otherwise, or (ii) ownership of fifty percent (50%) or more of the | ||
outstanding shares, or (iii) beneficial ownership of such entity. | ||
|
||
"You" (or "Your") shall mean an individual or Legal Entity | ||
exercising permissions granted by this License. | ||
|
||
"Source" form shall mean the preferred form for making modifications, | ||
including but not limited to software source code, documentation | ||
source, and configuration files. | ||
|
||
"Object" form shall mean any form resulting from mechanical | ||
transformation or translation of a Source form, including but | ||
not limited to compiled object code, generated documentation, | ||
and conversions to other media types. | ||
|
||
"Work" shall mean the work of authorship, whether in Source or | ||
Object form, made available under the License, as indicated by a | ||
copyright notice that is included in or attached to the work | ||
(an example is provided in the Appendix below). | ||
|
||
"Derivative Works" shall mean any work, whether in Source or Object | ||
form, that is based on (or derived from) the Work and for which the | ||
editorial revisions, annotations, elaborations, or other modifications | ||
represent, as a whole, an original work of authorship. For the purposes | ||
of this License, Derivative Works shall not include works that remain | ||
separable from, or merely link (or bind by name) to the interfaces of, | ||
the Work and Derivative Works thereof. | ||
|
||
"Contribution" shall mean any work of authorship, including | ||
the original version of the Work and any modifications or additions | ||
to that Work or Derivative Works thereof, that is intentionally | ||
submitted to Licensor for inclusion in the Work by the copyright owner | ||
or by an individual or Legal Entity authorized to submit on behalf of | ||
the copyright owner. For the purposes of this definition, "submitted" | ||
means any form of electronic, verbal, or written communication sent | ||
to the Licensor or its representatives, including but not limited to | ||
communication on electronic mailing lists, source code control systems, | ||
and issue tracking systems that are managed by, or on behalf of, the | ||
Licensor for the purpose of discussing and improving the Work, but | ||
excluding communication that is conspicuously marked or otherwise | ||
designated in writing by the copyright owner as "Not a Contribution." | ||
|
||
"Contributor" shall mean Licensor and any individual or Legal Entity | ||
on behalf of whom a Contribution has been received by Licensor and | ||
subsequently incorporated within the Work. | ||
|
||
2. Grant of Copyright License. Subject to the terms and conditions of | ||
this License, each Contributor hereby grants to You a perpetual, | ||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable | ||
copyright license to reproduce, prepare Derivative Works of, | ||
publicly display, publicly perform, sublicense, and distribute the | ||
Work and such Derivative Works in Source or Object form. | ||
|
||
3. Grant of Patent License. Subject to the terms and conditions of | ||
this License, each Contributor hereby grants to You a perpetual, | ||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable | ||
(except as stated in this section) patent license to make, have made, | ||
use, offer to sell, sell, import, and otherwise transfer the Work, | ||
where such license applies only to those patent claims licensable | ||
by such Contributor that are necessarily infringed by their | ||
Contribution(s) alone or by combination of their Contribution(s) | ||
with the Work to which such Contribution(s) was submitted. If You | ||
institute patent litigation against any entity (including a | ||
cross-claim or counterclaim in a lawsuit) alleging that the Work | ||
or a Contribution incorporated within the Work constitutes direct | ||
or contributory patent infringement, then any patent licenses | ||
granted to You under this License for that Work shall terminate | ||
as of the date such litigation is filed. | ||
|
||
4. Redistribution. You may reproduce and distribute copies of the | ||
Work or Derivative Works thereof in any medium, with or without | ||
modifications, and in Source or Object form, provided that You | ||
meet the following conditions: | ||
|
||
(a) You must give any other recipients of the Work or | ||
Derivative Works a copy of this License; and | ||
|
||
(b) You must cause any modified files to carry prominent notices | ||
stating that You changed the files; and | ||
|
||
(c) You must retain, in the Source form of any Derivative Works | ||
that You distribute, all copyright, patent, trademark, and | ||
attribution notices from the Source form of the Work, | ||
excluding those notices that do not pertain to any part of | ||
the Derivative Works; and | ||
|
||
(d) If the Work includes a "NOTICE" text file as part of its | ||
distribution, then any Derivative Works that You distribute must | ||
include a readable copy of the attribution notices contained | ||
within such NOTICE file, excluding those notices that do not | ||
pertain to any part of the Derivative Works, in at least one | ||
of the following places: within a NOTICE text file distributed | ||
as part of the Derivative Works; within the Source form or | ||
documentation, if provided along with the Derivative Works; or, | ||
within a display generated by the Derivative Works, if and | ||
wherever such third-party notices normally appear. The contents | ||
of the NOTICE file are for informational purposes only and | ||
do not modify the License. You may add Your own attribution | ||
notices within Derivative Works that You distribute, alongside | ||
or as an addendum to the NOTICE text from the Work, provided | ||
that such additional attribution notices cannot be construed | ||
as modifying the License. | ||
|
||
You may add Your own copyright statement to Your modifications and | ||
may provide additional or different license terms and conditions | ||
for use, reproduction, or distribution of Your modifications, or | ||
for any such Derivative Works as a whole, provided Your use, | ||
reproduction, and distribution of the Work otherwise complies with | ||
the conditions stated in this License. | ||
|
||
5. Submission of Contributions. Unless You explicitly state otherwise, | ||
any Contribution intentionally submitted for inclusion in the Work | ||
by You to the Licensor shall be under the terms and conditions of | ||
this License, without any additional terms or conditions. | ||
Notwithstanding the above, nothing herein shall supersede or modify | ||
the terms of any separate license agreement you may have executed | ||
with Licensor regarding such Contributions. | ||
|
||
6. Trademarks. This License does not grant permission to use the trade | ||
names, trademarks, service marks, or product names of the Licensor, | ||
except as required for reasonable and customary use in describing the | ||
origin of the Work and reproducing the content of the NOTICE file. | ||
|
||
7. Disclaimer of Warranty. Unless required by applicable law or | ||
agreed to in writing, Licensor provides the Work (and each | ||
Contributor provides its Contributions) on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or | ||
implied, including, without limitation, any warranties or conditions | ||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A | ||
PARTICULAR PURPOSE. You are solely responsible for determining the | ||
appropriateness of using or redistributing the Work and assume any | ||
risks associated with Your exercise of permissions under this License. | ||
|
||
8. Limitation of Liability. In no event and under no legal theory, | ||
whether in tort (including negligence), contract, or otherwise, | ||
unless required by applicable law (such as deliberate and grossly | ||
negligent acts) or agreed to in writing, shall any Contributor be | ||
liable to You for damages, including any direct, indirect, special, | ||
incidental, or consequential damages of any character arising as a | ||
result of this License or out of the use or inability to use the | ||
Work (including but not limited to damages for loss of goodwill, | ||
work stoppage, computer failure or malfunction, or any and all | ||
other commercial damages or losses), even if such Contributor | ||
has been advised of the possibility of such damages. | ||
|
||
9. Accepting Warranty or Additional Liability. While redistributing | ||
the Work or Derivative Works thereof, You may choose to offer, | ||
and charge a fee for, acceptance of support, warranty, indemnity, | ||
or other liability obligations and/or rights consistent with this | ||
License. However, in accepting such obligations, You may act only | ||
on Your own behalf and on Your sole responsibility, not on behalf | ||
of any other Contributor, and only if You agree to indemnify, | ||
defend, and hold each Contributor harmless for any liability | ||
incurred by, or claims asserted against, such Contributor by reason | ||
of your accepting any such warranty or additional liability. | ||
|
||
END OF TERMS AND CONDITIONS | ||
|
||
APPENDIX: How to apply the Apache License to your work. | ||
|
||
To apply the Apache License to your work, attach the following | ||
boilerplate notice, with the fields enclosed by brackets "[]" | ||
replaced with your own identifying information. (Don't include | ||
the brackets!) The text should be enclosed in the appropriate | ||
comment syntax for the file format. We also recommend that a | ||
file or class name and description of purpose be included on the | ||
same "printed page" as the copyright notice for easier | ||
identification within third-party archives. | ||
|
||
Copyright [yyyy] [name of copyright owner] | ||
|
||
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. |
Oops, something went wrong.