Commit 06cffea3 authored by Laurent Belcour's avatar Laurent Belcour Committed by Ludovic Courtès

[Doc][Update] The documentation of the main pages is now in a

satisfatory state for me.
parent d3b4de86
......@@ -2,8 +2,8 @@
\page contribute Contribute
You can contribute and expand ALTA by providing new plugins. The three kind
of plugins (\ref function, \ref data and \ref fitter) can be provided.
Examples of such plugins can be found in the $ALTA/sources/plugins
of plugins (\ref function, \ref data and \ref fitter) can be provided.
Examples of such plugins can be found in the `$ALTA/sources/plugins`
directory.
......
......@@ -5,7 +5,7 @@
<!-- This page lists all documentation related to the ALTA library. -->
#### APIs
#### APIs
ALTA provides two programming APIs. At the lowest level, it is possible to author new \ref plugins "plugins" and \ref commands "commands" using the C++ API. At the highest level, it is possible to build Python scripts by directly manipulating plugins in this language.
......@@ -17,8 +17,6 @@ ALTA provides two programming APIs. At the lowest level, it is possible to autho
ALTA permits to manipulate various type of files. Here, we detail: our internal data file format which can be either ASCII or binary; our function file format to store function parameters; and our XML file format to store high-level scripts.
\todo Separate the different file format
+ \ref format "Data file format"
+ \ref format "Function file format"
+ \ref format "XML scripting format"
......@@ -26,10 +24,12 @@ ALTA permits to manipulate various type of files. Here, we detail: our internal
#### BRDF Related Documents
+ <a href="classparams.html" >Parametrisations </a> supported in ALTA
ALTA can manipulate BRDF data in different parametrization of the input space of those functions. A BRDF is defined as \f$y = \rho(\omega_i, \omega_o)\f$, where \f$\omega_i, \omega_o \in \Omega\f$ the hemisphere of directions. Multiple way to parametrize this space exist, and we implement most of them. See <a href="classparams.html" >Parametrisations supported in ALTA</a> for more details.
#### References
#### Reference
Below are referenced all the different plugins and softwares provided with ALTA. Documentation on how to use them is provided on the different pages.
+ List of plugin to convert data (cf. \ref datas)
+ List of plugins to fit data (cf. \ref fitters)
......
......@@ -111,6 +111,19 @@ Examples of configuration files are provided under
<tt>configs/scons</tt>.
## Configuration of the environment
To have a direct access to ALTA's commands and plugins from the command line and from python, we recommend to use our environment setters scripts. On Linux/OSX, please source setpath.sh from the terminal:
$ source setpath.sh
On MS Windows, please excecute the script setpath.bat from the command line:
$ ./setpath.bat
Programs and plugins will be accessible from the command line without requiring to specify the absolute or relative path to your current position.
## Testing
ALTA comes with a test suite that can be run with:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment