From 97e17957043783d5b19afb2eb3152fdfd5e6c0bf Mon Sep 17 00:00:00 2001 From: Sameer Agarwal Date: Sun, 26 May 2013 11:48:09 -0700 Subject: [PATCH] Minor documentation fixes Change-Id: Ic531475acf2386b6f5839d2434bdcc1e4c730d14 --- docs/source/building.rst | 21 +++++++++++---------- docs/source/introduction.rst | 23 +++++++++++++---------- 2 files changed, 24 insertions(+), 20 deletions(-) diff --git a/docs/source/building.rst b/docs/source/building.rst index 9ae6c890c..8229cc4f3 100644 --- a/docs/source/building.rst +++ b/docs/source/building.rst @@ -4,8 +4,10 @@ Building Ceres Solver ===================== -Ceres source code and documentation are hosted at `code.google.com -`_. +Stable Ceres Solver releases are available for download at +`code.google.com `_. For the +more adventurous, the git repository is hosted on `Gerrit +`_. .. _section-dependencies: @@ -37,7 +39,7 @@ strongly recommend building the library with gflags. 5. `SuiteSparse `_ is used for sparse matrix analysis, ordering and factorization. In particular -Ceres uses the AMD, COLAMD and CHOLMOD libraries. This is an optional +Ceres uses the AMD, CAMD, COLAMD and CHOLMOD libraries. This is an optional dependency. 6. `CXSparse `_ is @@ -92,8 +94,7 @@ platform. Start by installing all the dependencies. # protobuf sudo apt-get install libprotobuf-dev -We are now ready to build and test Ceres. Note that ``CMake`` requires -the exact path to the ``libglog.a`` and ``libgflag.a``. +We are now ready to build and test Ceres. .. code-block:: bash @@ -110,8 +111,7 @@ dataset [Agarwal]_. .. code-block:: bash - bin/simple_bundle_adjuster \ - ../ceres-solver-1.6.0/data/problem-16-22106-pre.txt \ + bin/simple_bundle_adjuster ../ceres-solver-1.6.0/data/problem-16-22106-pre.txt This runs Ceres for a maximum of 10 iterations using the ``DENSE_SCHUR`` linear solver. The output should look something like @@ -172,9 +172,10 @@ Building on Mac OS X ==================== On OS X, we recommend using the `homebrew -`_ package manager. Start by -installing all the dependencies. OS X ships with well optimized BLAS -and LAPACK routines as part of the `vecLib +`_ package manager to install the +dependencies. There is no need to install ``BLAS`` or ``LAPACK`` +separately as OS X ships with optimized ``BLAS`` and ``LAPACK`` +routines as part of the `vecLib `_ framework. diff --git a/docs/source/introduction.rst b/docs/source/introduction.rst index 5df765b9f..835a06463 100644 --- a/docs/source/introduction.rst +++ b/docs/source/introduction.rst @@ -8,17 +8,9 @@ Solving nonlinear least squares problems [#f1]_ comes up in a broad range of areas across science and engineering - from fitting curves in statistics, to constructing 3D models from photographs in computer vision. Ceres Solver [#f2]_ [#f3]_ is a portable C++ library for -solving non-linear least squares problems. It is designed to solve -small and large sparse problems accurately and efficiently. +solving non-linear least squares problems accurately and efficiently. -At Google, Ceres Solver has been used for solving a variety of -problems in computer vision and machine learning. e.g., it is used to -to estimate the pose of Street View cars, aircrafts, and satellites; -to build 3D models for PhotoTours; to estimate satellite image sensor -characteristics, and more. - - -Features: +**Features** #. A friendly :ref:`chapter-modeling`. @@ -52,6 +44,17 @@ Features: underway. +At Google, Ceres Solver has been used for solving a variety of +problems in computer vision and machine learning. e.g., it is used to +to estimate the pose of Street View cars, aircrafts, and satellites; +to build 3D models for PhotoTours; to estimate satellite image sensor +characteristics, and more. + +`Blender `_ uses Ceres for `motion tracking +`_ and +`bundle adjustment +`_. + .. rubric:: Footnotes