Skip to content

Commit 7df59d6

Browse files
Merge pull request #196 from Gouderg/hotfix-singularity
More example to singularity documentation
2 parents ead3226 + ac35784 commit 7df59d6

File tree

1 file changed

+28
-13
lines changed

1 file changed

+28
-13
lines changed

source/tutorials.rst

Lines changed: 28 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -299,34 +299,49 @@ Docker has a lamentable use of space and by default does not clean up excess dat
299299
Using Singularity
300300
*****************
301301

302-
[Singularity](https://sylabs.io/) is another container platform able to run Docker images. Singularity can be run both on local machins and in instances where the user does not have root access. Instances where a user may not have root privlidges include HPC clusters and cloud cluster resources.
302+
`Singularity <https://sylabs.io/>`__ is another container platform able to run Docker images.
303+
Singularity can be run both on local machins and in instances where the user does not have root access.
304+
Instances where a user may not have root privlidges include HPC clusters and cloud cluster resources.
303305
A container is a single file without anything else to install.
304306

305-
Downloading image
306-
=================
307-
Singularity can use ODM Docker container after their download. It creates .sif images
307+
Build Singularity image from Docker image
308+
=========================================
309+
Singularity can use Docker image to build SIF image.
308310

309-
For latest ODM Docker image (Recommended)
311+
For latest ODM Docker image (Recommended) :
310312

311313
.. code:: bash
312-
singularity pull --disable-cache docker://opendronemap/odm:latest
313314
314-
For latest ODM GPU Docker image
315+
singularity build --disable-cache -f odm_latest.sif docker://opendronemap/odm:latest
316+
317+
For latest ODM GPU Docker image :
315318

316319
.. code:: bash
317-
singularity pull --disable-cache docker://opendronemap/odm:gpu
320+
321+
singularity build --disable-cache -f odm_gpu.sif docker://opendronemap/odm:gpu
318322
319323
Using Singularity SIF image
320324
===========================
321325

322-
Once you have used one of the above commands to download and create the `odm_latest.sif` image, it can be ran using singularity.
323-
Place your images in a directory named “images” (for example /my/project/images) , then simply run
324326

325-
..code:: bash
327+
Once you have used one of the above commands to download and create the `odm_latest.sif` image, it can be ran using singularity.
328+
Place your images in a directory named “images” (for example /my/project/images) , then simply run :
329+
330+
.. code:: bash
326331
327-
singularity run --bind /my/project:datasets/code odm_latest.sif --project-path /datasets
332+
singularity run --bind /my/project:/datasets/code odm_latest.sif --project-path /datasets
333+
334+
Like with docker, additional `Options and Flags <https://docs.opendronemap.org/arguments/>`_ can be added to the command :
335+
336+
.. code:: bash
328337
329-
Like with docker, additional Options and Flags can be added to the command.
338+
singularity run --bind /my/project:/datasets/code \
339+
--writable-tmpfs odm_latest.sif \
340+
--orthophoto-png --mesh-octree-depth 12 --ignore-gsd --dtm \
341+
--smrf-threshold 0.4 --smrf-window 24 --dsm --pc-csv --pc-las --orthophoto-kmz \
342+
--ignore-gsd --matcher-type flann --feature-quality ultra --max-concurrency 16 \
343+
--use-hybrid-bundle-adjustment --build-overviews --time --min-num-features 10000 \
344+
--project-path /datasets
330345
331346
*************************************
332347
Using ODM from low-bandwidth location

0 commit comments

Comments
 (0)