Skip to content
natowi edited this page May 30, 2020 · 9 revisions

RST essentials

Sections

 First
 =====

 Second
 ~~~~~~

 Third
 +++++

 Fourth
 ------

Link

`AliceVision <https://github.com/alicevision/AliceVision>`_

Infobox:

warning

 .. warning::

   Meshroom requires

note

 .. note::

   *No Python 2.7 support on Windows?*

Table

tab1

+--------------------------------------------------------------------------+
| Minimum requirements                                                     |
+===================+======================================================+
| Operating systems | Windows x64, Linux, Mac OS X (some work required)    |
+-------------------+------------------------------------------------------+
| CPU               | Recent Intel or AMD cpus                             |
+-------------------+------------------------------------------------------+
| RAM Memory        | 8 GB                                                 |
+-------------------+------------------------------------------------------+
| Hard Drive        | ~400MB for Meshroom + space for your data            |
+-------------------+------------------------------------------------------+
| GPU               | NVIDIA CUDA-enabled GPU (compute capability >= 2.0)  |
+-------------------+------------------------------------------------------+

Enum

dotl

* Windows: Python 3 (>=3.5)

* Linux / Mac OS X: Python 3 (>=3.5) or Python 2 (>= 2.7)

Good reference document: source/install/requirements/requirements.rst

Code

.. code::

  git clone --recursive git://github.com/alicevision/meshroom
  cd meshroom
  pip install -r requirements.txt

Code-block Bash

.. code-block:: bash

  pip install -r requirements.txt -r dev_requirements.txt

Var

``ALICEVISION_INSTALL``

Good reference document: source/install/download/download.rst


Bibtex

In the text insert

:cite:`Kneip2011`

in

source/refs.bib

instert the reference in bibtex format:

@inproceedings{Kneip2011,
author = {Kneip, Laurent and Scaramuzza, Davide and Siegwart, Roland},
year = {2011},
month = {06},
pages = {2969-2976},
title = {A novel parametrization of the perspective-three-point problem for a direct computation of absolute camera position and orientation},
booktitle = {CVPR, IEEE Computer Society Conference on Computer Vision and Pattern Recognition. IEEE Computer Society Conference on Computer Vision and Pattern Recognition},
journal = {Proceedings of the IEEE Computer Society Conference on Computer Vision and Pattern Recognition},
doi = {10.1109/CVPR.2011.5995464}
}

Glossary

add in entry in

glossary/glossary.rst

https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html?highlight=glossary#directive-glossary

The following role creates a cross-reference to a term in a glossary:

:term:

Reference to a term in a glossary. A glossary is created using the glossary directive containing a definition list with terms and definitions. It does not have to be in the same file as the term markup, for example the Python docs have one global glossary in the glossary.rst file.

https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-term

Clone this wiki locally