renamed main to demo and updated script

Author: franioli

README.md

@@ -70,16 +70,18 @@ For installing deep-image-matching, we recommend using [uv](https://docs.astral.
 curl -LsSf https://astral.sh/uv/install.sh | sh
 
 # Create and activate a virtual environment
-uv venv deep-image-matching --python 3.9
+uv venv --python 3.9
 source .venv/bin/activate  # On Windows: .venv\Scripts\activate
 ```
 
 Then, you can install deep-image-matching using uv:
 
 ```bash
-uv pip install deep-image-matching
+uv pip install -e .
 ```
 
+This command will install the package in editable mode, allowing you to modify the source code and see changes immediately without needing to reinstall. If you want to use deep-image-matching as a non-editable library, you can also install it without the `-e` flag.
+
 If there is any issue with the installation, you can also install the package from the source code.
 Clone the repository and install deep-image-matching in development mode:
 
@@ -97,12 +99,18 @@ uv pip install pycolmap==0.6.1
 
 Pycolmap is optional to run reconstruction directly in DIM. If pycolmap is not available, matches will be written both in a h5 and colmap database for later processing with COLMAP GUI or API, or other processing.
 
-Try to run the tests to check if deep-image-matching is correctly installed, try to import the package in a Python shell:
+To verify that deep-image-matching is correctly installed, you can try to import the package in a Python shell:
 
 ```python
 import deep_image_matching as dim
 ```
 
+To test most of the functionality, run the tests to check if deep-image-matching is correctly installed, run:
+
+```bash
+uv pytest tests
+```
+
 For more information, check the [documentation](https://3dom-fbk.github.io/deep-image-matching/installation/).
 
 ### Why uv?
@@ -129,7 +137,7 @@ pip install deep-image-matching
 
 If you prefer using Docker, first, build the image:
 
-```
+```bash
 docker build --tag deep-image-matching .
 ```
 
@@ -138,13 +146,13 @@ Note that the first time you run the command, it will take a while to download t
 Once the image is built, you can run it with the following commands.
 On Linux:
 
-```
+```bash
 docker run --name run-deep-image-matching --mount type=bind,source=/home/username/data,target=/workspace/data --gpus all -it deep-image-matching
 ```
 
 On Windows (please use Powershell):
 
-```
+```powershell
 docker run --name run-deep-image-matching --mount type=bind,source=D:\data,target=/workspace/data --gpus all -it deep-image-matching
 ```
 

demo.ipynb

@@ -23,7 +23,8 @@
           "name": "stdout",
           "output_type": "stream",
           "text": [
-            "Deep Image Matching loaded in 10.390 seconds.\n"
+            "Deep Image Matching loaded in 4.188 seconds.\n",
+            "\u001b[1;33m2025-07-02 17:09:13 | [WARNING ] assets/example_cyprus/results_superpoint+lightglue_matching_lowres_quality_medium already exists, but the '--force' option is used. Deleting the folder.\u001b[0m\n"
           ]
         }
       ],
@@ -46,12 +47,12 @@
       "cell_type": "markdown",
       "metadata": {},
       "source": [
-        "Run feature extraction and matching"
+        "Run feature extraction and matching\n"
       ]
     },
     {
       "cell_type": "code",
-      "execution_count": 2,
+      "execution_count": null,
       "metadata": {},
       "outputs": [
         {
@@ -235,12 +236,12 @@
       "cell_type": "markdown",
       "metadata": {},
       "source": [
-        "Export matches to COLMAP format"
+        "Export matches to COLMAP format\n"
       ]
     },
     {
       "cell_type": "code",
-      "execution_count": 3,
+      "execution_count": null,
       "metadata": {},
       "outputs": [
         {
@@ -275,12 +276,12 @@
       "cell_type": "markdown",
       "metadata": {},
       "source": [
-        "Run reconstruction with pycolmap"
+        "Run reconstruction with pycolmap\n"
       ]
     },
     {
       "cell_type": "code",
-      "execution_count": 4,
+      "execution_count": null,
       "metadata": {},
       "outputs": [
         {
@@ -373,7 +374,7 @@
   ],
   "metadata": {
     "kernelspec": {
-      "display_name": "Python 3",
+      "display_name": "deep-image-matching (3.9.23)",
       "language": "python",
       "name": "python3"
     },

demo.py

@@ -51,15 +51,38 @@
     except ImportError:
         logger.error("pyvis is not available. Unable to visualize view graph.")
 
-# If --skip_reconstruction is not specified, run reconstruction
+# If --skip_reconstruction is not specified, run reconstruction with pycolmap
+if not config.general["skip_reconstruction"]:
+    from deep_image_matching.reconstruction import pycolmap_reconstruction
+
+    # Optional - You can specify some reconstruction configuration
+    # reconst_opts = (
+    #     {
+    #         "ba_refine_focal_length": True,
+    #         "ba_refine_principal_point": False,
+    #         "ba_refine_extra_params": False,
+    #     },
+    # )
+    reconst_opts = {}
+    refine_intrinsics = config.general.get("refine_intrinsics", True)
+
+    # Run reconstruction
+    model = pycolmap_reconstruction(
+        database_path=output_dir / "database.db",
+        sfm_dir=output_dir,
+        image_dir=imgs_dir,
+        options=reconst_opts,
+        verbose=config.general["verbose"],
+        refine_intrinsics=refine_intrinsics,
+    )
+
 # Export in openMVG format
 if config.general["openmvg_conf"]:
     with open(config.general["openmvg_conf"]) as file:
         openmvgcfg = yaml.safe_load(file)
     openmvg_sfm_bin = openmvgcfg["general"]["path_to_binaries"]
     openmvg_database = openmvgcfg["general"]["openmvg_database"]
     openmvg_out_path = output_dir / "openmvg"
-
     dim.io.export_to_openmvg(
         img_dir=imgs_dir,
         feature_path=feature_path,
@@ -70,46 +93,12 @@
         camera_config_path=config.general["camera_options"],
     )
 
-    # Reconstruction with OpenMVG
-    reconstruction = import_module("deep_image_matching.openmvg_reconstruction")
-    reconstruction.main(
-        openmvg_out_path=openmvg_out_path,
-        skip_reconstruction=config.general["skip_reconstruction"],
-        openmvg_sfm_bin=openmvg_sfm_bin,
-    )
+    # If skip_reconstruction is not specified, run OpenMVG reconstruction
+    if not config.general["skip_reconstruction"]:
+        from deep_image_matching.openmvg import openmvg_reconstruction
 
-# Reconstruction with pycolmap
-if not config.general["skip_reconstruction"]:
-    use_pycolmap = True
-    try:
-        # To be sure, check if pycolmap is available, otherwise skip reconstruction
-        pycolmap = import_module("pycolmap")
-        logger.info(f"Using pycolmap version {pycolmap.__version__}")
-    except ImportError:
-        logger.error("Pycomlap is not available.")
-        use_pycolmap = False
-
-    if use_pycolmap:
-        # import reconstruction module
-        reconstruction = import_module("deep_image_matching.reconstruction")
-
-        # Optional - You can specify some reconstruction configuration
-        # reconst_opts = (
-        #     {
-        #         "ba_refine_focal_length": True,
-        #         "ba_refine_principal_point": False,
-        #         "ba_refine_extra_params": False,
-        #     },
-        # )
-        reconst_opts = {}
-        refine_intrinsics = config.general.get("refine_intrinsics", True)
-
-        # Run reconstruction
-        model = reconstruction.pycolmap_reconstruction(
-            database_path=output_dir / "database.db",
-            sfm_dir=output_dir,
-            image_dir=imgs_dir,
-            options=reconst_opts,
-            verbose=config.general["verbose"],
-            refine_intrinsics=refine_intrinsics,
+        openmvg_reconstruction(
+            openmvg_out_path=openmvg_out_path,
+            skip_reconstruction=config.general["skip_reconstruction"],
+            openmvg_sfm_bin=openmvg_sfm_bin,
         )

…image_matching/openmvg_reconstruction.py src/deep_image_matching/openmvg.pysrc/deep_image_matching/openmvg_reconstruction.py renamed to src/deep_image_matching/openmvg.py src/deep_image_matching/openmvg_reconstruction.py renamed to src/deep_image_matching/openmvg.py

@@ -7,7 +7,7 @@
 from .constants import logger
 
 
-def main(
+def openmvg_reconstruction(
     openmvg_out_path: Path,
     skip_reconstruction: bool,
     openmvg_sfm_bin: Path = None,