isl-org
diff --git a/‎.travis.yml‎
Lines changed: 23 additions & 75 deletions b/‎.travis.yml‎
Lines changed: 23 additions & 75 deletions
diff --git a/‎3rdparty‎ b/‎3rdparty‎
diff --git a/‎docs/tutorial/docker/docker-gui.rst‎
Lines changed: 146 additions & 0 deletions b/‎docs/tutorial/docker/docker-gui.rst‎
Lines changed: 146 additions & 0 deletions
@@ -3,6 +3,7 @@ env:
   global:
     - SHARED=OFF
     - BUILD_DEPENDENCY_FROM_SOURCE=OFF
+    - NPROC=2
 
 notifications:
   email:
@@ -27,6 +28,8 @@ matrix:
             - g++-4.8
             - cmake-data # to use cmake 3.0 or more recent
             - cmake
+      before_install: ./util/scripts/setup-linux.sh
+      script: ./util/scripts/run-travis.sh
 
     - os: linux
       dist: trusty
@@ -43,6 +46,8 @@ matrix:
             - cmake-data # to use cmake 3.0 or more recent
             - cmake
       env: SHARED=ON
+      before_install: ./util/scripts/setup-linux.sh
+      script: ./util/scripts/run-travis.sh
 
     - os: linux
       dist: trusty
@@ -59,6 +64,8 @@ matrix:
             - cmake-data # to use cmake 3.0 or more recent
             - cmake
       env: BUILD_DEPENDENCY_FROM_SOURCE=ON
+      before_install: ./util/scripts/setup-linux.sh
+      script: ./util/scripts/run-travis.sh
 
     # Similar environment of Ubuntu 16.04 (gcc 5.4)
     # travis ci only supports Ubuntu 14.04 (trusty) gcc-5 and 6
@@ -77,98 +84,39 @@ matrix:
             - g++-6
             - cmake-data # to use cmake 3.0 or more recent
             - cmake
+      before_install: ./util/scripts/setup-linux.sh
+      script: ./util/scripts/run-travis.sh
 
     # Default environment of MacOS El Capitan
     # compiled using clang shipped with xcode8
     - os: osx
       osx_image: xcode8
+      script: travis_wait 30 ./util/scripts/run-travis.sh
+      before_install: ./util/scripts/setup-osx.sh
 
     - os: osx
       osx_image: xcode8
       env: SHARED=ON
+      before_install: ./util/scripts/setup-osx.sh
+      script: travis_wait 30 ./util/scripts/run-travis.sh
 
     # Default environment of MacOS 10.13
     # compiled using clang shipped with xcode10.1
     - os: osx
       osx_image: xcode10.1
+      script: travis_wait 30 ./util/scripts/run-travis.sh
+      before_install: ./util/scripts/setup-osx.sh
 
     - os: osx
       osx_image: xcode10.1
       env: BUILD_DEPENDENCY_FROM_SOURCE=ON
+      script: travis_wait 30 ./util/scripts/run-travis.sh
+      before_install: ./util/scripts/setup-osx.sh
 
-before_install:
-  - if [ "$TRAVIS_OS_NAME" == "linux" ]; then
-      ./util/scripts/install-deps-ubuntu.sh;
-      ./util/scripts/make-documentation.sh;
-      ./util/scripts/install-gtest.sh;
-    fi
-  # scripts/install-deps-osx.sh works well
-  - if [ "$TRAVIS_OS_NAME" == "osx" ]; then
-      ./util/scripts/install-deps-osx.sh;
-      ./util/scripts/install-gtest.sh;
-    fi
+    - env: DOCKER=YES UBUNTU=16.04 BUNDLE=deps ENV=py3 LINK=STATIC
+      script: ./util/docker/open3d-test/tools/test.sh $UBUNTU $BUNDLE $ENV $LINK
+      before_install: sudo apt-get update && sudo apt-get install -y realpath
 
-  # for reference, display cmake and python version
-  - python -V
-  - cmake --version
-  - export nproc=2
-  # - pip install numpy
-
-script:
-  # Build and install to CMake's default install path
-  - python -V
-  - git submodule update --init --recursive
-  - mkdir build
-  - cd build
-  - if [ "$BUILD_DEPENDENCY_FROM_SOURCE" == "OFF" ]; then
-      cmake -DBUILD_SHARED_LIBS=$SHARED -DBUILD_UNIT_TESTS=ON ..;
-    else
-      cmake -DBUILD_SHARED_LIBS=$SHARED -DBUILD_UNIT_TESTS=ON -DBUILD_EIGEN3=ON
-            -DBUILD_GLEW=ON -DBUILD_GLFW=ON -DBUILD_JPEG=ON -DBUILD_JSONCPP=ON
-            -DBUILD_PNG=ON ..;
-    fi
-  # make -j brings 'virtual memory exhausted: Cannot allocate memory' message
-  # this is presumably due to limited memory space of travis-ci
-  # also set the time limit to 30 mins, this is a fix to issue #557
-  - travis_wait 30 sudo make install -j$nproc
-  - ./bin/unitTests
-  - test=`cmake --find-package -DNAME=Open3D -DCOMPILER_ID=GNU -DLANGUAGE=C -DMODE=EXIST`
-  - if [ "$test" == "Open3D found." ]; then
-      echo "PASSED find_package(Open3D) in default install path.";
-    else
-      echo "FAILED find_package(Open3D) in default install path.";
-      exit 1;
-    fi
-
-  # Reconfig and install in a specified CMAKE_INSTALL_PREFIX
-  - sudo make uninstall
-  - if [ "$BUILD_DEPENDENCY_FROM_SOURCE" == "OFF" ]; then
-      cmake -DBUILD_SHARED_LIBS=$SHARED -DBUILD_UNIT_TESTS=ON
-            -DCMAKE_INSTALL_PREFIX=~/open3d_install ..;
-    else
-      cmake -DBUILD_SHARED_LIBS=$SHARED -DBUILD_UNIT_TESTS=ON -DBUILD_EIGEN3=ON
-            -DBUILD_GLEW=ON -DBUILD_GLFW=ON -DBUILD_JPEG=ON -DBUILD_JSONCPP=ON
-            -DBUILD_PNG=ON -DCMAKE_INSTALL_PREFIX=~/open3d_install ..;
-    fi
-  - travis_wait 30 sudo make install -j$nproc
-  - test=`cmake --find-package -DNAME=Open3D -DCOMPILER_ID=GNU -DLANGUAGE=C -DMODE=EXIST
-                -DCMAKE_PREFIX_PATH="~/open3d_install/lib/cmake"`
-  - if [ "$test" == "Open3D found." ]; then
-      echo "PASSED find_package(Open3D) in specified install path.";
-    else
-      echo "FAILED find_package(Open3D) in specified install path.";
-      exit 1;
-    fi
-
-  # Test building example with installed Open3D
-  - cd ../docs/_static/C++
-  - mkdir build
-  - cd build
-  - cmake -DCMAKE_INSTALL_PREFIX=~/open3d_install ..
-  - make
-  - ./TestVisualizer
-
-  # The following script has issues on SHARED = "ON"
-  # - if [ "$SHARED" == "OFF" ]; then
-  #     cd lib/Tutorial/Basic/ && python file_io.py
-  #   fi
+    - env: DOCKER=YES UBUNTU=16.04 BUNDLE=deps ENV=py3 LINK=SHARED
+      script: ./util/docker/open3d-test/tools/test.sh $UBUNTU $BUNDLE $ENV $LINK
+      before_install: sudo apt-get update && sudo apt-get install -y realpath
@@ -0,0 +1,146 @@
+.. _docker-gui:
+
+Docker GUI
+----------
+
+The following document describes a solution for utilizing Open3D with GUI/visualization under Docker.
+
+Utilizing this approach the user can:
+
+- sandbox Open3D from other applications on a machine
+- operate Open3D on a headless machine using VNC or the terminal
+- edit the Open3D code on the host side but run it inside an Open3D container
+
+This recipe was developed and tested on Ubuntu 18.04. Other distributions might need slightly different instructions.
+
+.. _docker-gui-usage-notes:
+
+Usage notes
+===========
+
+.. _docker-gui-files:
+
+Docker files
+````````````
+
+The docker setup files and tools can be found under `Open3d/util/docker/open3d-xvfb <https://github.com/IntelVCL/Open3D/tree/docker/util/docker/open3d-xvfb>`_.
+
+    - Dockerfile
+    - setup
+        - entrypoint.s
+        - docker_sample.sh
+    - tools
+        - attach.sh
+        - build.sh
+        - delete.sh
+        - name.sh
+        - prune.sh
+        - run.sh
+        - stop.sh
+
+**Dockerfile**
+
+``Dockerfile`` is the Docker script used to build the Open3D image.
+
+**Tools**
+
+We provide a number of Docker tools for convenience:
+
+- ``attach.sh``
+  Attach a terminal to a running Open3D docker container.
+- ``build.sh``
+  Build the Open3D docker image.
+- ``delete.sh``
+  Delete the Open3D image.
+- ``prune.sh``
+  Delete **all** stopped containers and **all** dangling images.
+- ``run.sh``
+  Run the Open3D container. Checkout Open3D, build and install.
+- ``stop.sh``
+  Stop the Open3D container.
+
+A typical flow of events when working with docker looks like this:
+
+.. code-block:: sh
+
+    $ cd <open3d_path>/util/docker/open3d_xvfb/tools
+    $ ./build.sh
+    $ ./run.sh
+    root@open3d-xvfb:~/open3d/build# <do some stuff>
+    root@open3d-xvfb:~/open3d/build# exit
+    $ ./attach.sh
+    root@open3d-xvfb:~/open3d# <do some stuff>
+    root@open3d-xvfb:~/open3d# exit
+    $ ./stop.sh
+
+Building the Open3D Docker image will take approximately 10-15 minutes to complete.
+At the end the image will be ~1GB in size.
+
+Running the Open3D Docker container will perform the following steps:
+
+- git clone Open3D master to ``~/open3d_docker``
+- run the container in interactive mode with the host path ``~/open3d_docker`` mounted inside the container at ``/root/Open3D``
+- build Open3D and install inside the docker container.
+- attach a terminal to the Open3D container for command line input from the host side
+
+In order to disconnect from a running container type ``exit`` at the terminal.
+You can still attach to a running container at a later time.
+
+The Open3D container is automatically removed when stopped.
+None of the Open3D files are removed as they in fact reside on the host due to the Docker bind mounting functionality.
+In order to keep the container around (and not have to rebuild the Open3D binaries every time) remove the ``-rm`` option in ``run.sh``.
+
+Prunning images/containers is useful when modifying/testing a new image.
+It cleans up the docker workspace and frees up disk space.
+
+.. _docker-gui-remote-access:
+
+Remote access
+`````````````
+
+VNC can be used to remote into a running docker container.
+
+A running Open3D container listens to port 5920 on the host.
+The ``run.sh`` script redirects host port 5920 to container port 5900.
+
+This allows remoting into the container using VNC to ``<host ip>:5920``.
+The default password is ``1234`` and can be changed in ``Open3D/issue_17/util/docker/open3d-xvfb/setup/entrypoint.sh`` (requires rebuilding the Open3D Docker image with ``build.sh``).
+Once connected you can use Open3D as usual.
+
+.. _docker-gui-host-terminal:
+
+Running at the host terminal
+````````````````````````````
+
+It is also possible to run Open3D from a host terminal attached to a running Open3D Docker container.
+An example on how this can be perfomed:
+
+.. code-block:: sh
+
+    # at the host terminal
+    $ sudo cp ~/open3d_docker/util/docker/open3d-xvfb/setup/docker_sample.sh \
+              ~/open3d_docker/build/lib/Tutorial/Advanced
+    $ cd ~/open3d_docker/utilities/docker/open3d-xvfb/tools
+    $ ./attach.sh
+
+    # at the container terminal
+    $ cd ~/open3d/build/lib/Tutorial/Advanced
+    $ sh docker_sample.sh
+
+.. _docker-gui-limitations:
+
+Limitations
+===========
+
+- | the ``lxde`` user interface needs more configuring.
+  | Some things won't work as expected. For example the ``UXTerm`` doesn't start and ``lxterminal`` may crash occasionally.
+- | the container screen resolution is set to 1280x1024x8.
+  | The resolution will be increased in the future.
+- | there are some rendering issues.
+  | Some images may be saved incorrectly to the disk. For example, when running the ``headless_sample.py`` sample the color images saved to the disk are black.
+- | ``run.sh`` clones Open3D to a hardcoded location: ``~/open3d_docker``
+  | We are considering the following alternatives:
+
+    - let the user specify the destination
+    - reuse the current location of Open3D
+