Skip to content

Commit 7306905

Browse files
move singularity next to HPC
1 parent a8bda14 commit 7306905

File tree

1 file changed

+48
-48
lines changed

1 file changed

+48
-48
lines changed

source/tutorials.rst

Lines changed: 48 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -295,54 +295,6 @@ Cleaning up after Docker
295295

296296
Docker has a lamentable use of space and by default does not clean up excess data and machines when processes are complete. This can be advantageous if we need to access a process that has since terminated, but carries the burden of using increasing amounts of storage over time. Maciej Łebkowski has an `excellent overview of how to manage excess disk usage in docker <https://lebkowski.name/docker-volumes/>`_.
297297

298-
*****************
299-
Using Singularity
300-
*****************
301-
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.
305-
A container is a single file without anything else to install.
306-
307-
Build Singularity image from Docker image
308-
=========================================
309-
Singularity can use Docker image to build SIF image.
310-
311-
For latest ODM Docker image (Recommended) :
312-
313-
.. code:: bash
314-
315-
singularity build --disable-cache -f odm_latest.sif docker://opendronemap/odm:latest
316-
317-
For latest ODM GPU Docker image :
318-
319-
.. code:: bash
320-
321-
singularity build --disable-cache -f odm_gpu.sif docker://opendronemap/odm:gpu
322-
323-
Using Singularity SIF image
324-
===========================
325-
326-
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
331-
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
337-
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
345-
346298
*************************************
347299
Using ODM from low-bandwidth location
348300
*************************************
@@ -869,6 +821,54 @@ For instance, point clouds properties can be modified to show elevation and also
869821

870822
`Learn to edit <https://github.com/opendronemap/docs#how-to-make-your-first-contribution>`_ and help improve `this page <https://github.com/OpenDroneMap/docs/blob/publish/source/tutorials.rst>`_!
871823

824+
*****************
825+
Using Singularity
826+
*****************
827+
828+
`Singularity <https://sylabs.io/>`__ is another container platform able to run Docker images.
829+
Singularity can be run both on local machins and in instances where the user does not have root access.
830+
Instances where a user may not have root privlidges include HPC clusters and cloud cluster resources.
831+
A container is a single file without anything else to install.
832+
833+
Build Singularity image from Docker image
834+
=========================================
835+
Singularity can use Docker image to build SIF image.
836+
837+
For latest ODM Docker image (Recommended) :
838+
839+
.. code:: bash
840+
841+
singularity build --disable-cache -f odm_latest.sif docker://opendronemap/odm:latest
842+
843+
For latest ODM GPU Docker image :
844+
845+
.. code:: bash
846+
847+
singularity build --disable-cache -f odm_gpu.sif docker://opendronemap/odm:gpu
848+
849+
Using Singularity SIF image
850+
===========================
851+
852+
853+
Once you have used one of the above commands to download and create the `odm_latest.sif` image, it can be ran using singularity.
854+
Place your images in a directory named “images” (for example /my/project/images) , then simply run :
855+
856+
.. code:: bash
857+
858+
singularity run --bind /my/project:/datasets/code odm_latest.sif --project-path /datasets
859+
860+
Like with docker, additional `Options and Flags <https://docs.opendronemap.org/arguments/>`_ can be added to the command :
861+
862+
.. code:: bash
863+
864+
singularity run --bind /my/project:/datasets/code \
865+
--writable-tmpfs odm_latest.sif \
866+
--orthophoto-png --mesh-octree-depth 12 --ignore-gsd --dtm \
867+
--smrf-threshold 0.4 --smrf-window 24 --dsm --pc-csv --pc-las --orthophoto-kmz \
868+
--ignore-gsd --matcher-type flann --feature-quality ultra --max-concurrency 16 \
869+
--use-hybrid-bundle-adjustment --build-overviews --time --min-num-features 10000 \
870+
--project-path /datasets
871+
872872
873873
***************************************************
874874
ClusterODM, NodeODM, SLURM, with Singularity on HPC

0 commit comments

Comments
 (0)