Documentation
This page describes the three levels of documentation provided within the Uranie platform. All of these are directly available on this website. The two first (methodology and user manual) are provided precompiled within sources of Uranie. The last one, developer's manual, being optional, should be compiled specifically if requested to be be installed on machine and helps describe the technical implementation of methods. All these are written in a (fairly) good english, but few notes, more pedagogical materials, have only been written in french and are nonetheless available here.A new version of the documentation is being developed from som times in order to make the developer's life easier but also to automatise more tests and versions installation (along with update of this very website). This new version is based on Sphinx and can be accessed with the path below and in the navigation bar. This new documentation is still under development and is not yet full, some parts are still missing.
The different kind of documentation
This documentation level aims at introducing the methods, from a very theoretical point of view. This is the main addition of this documentation: it provides a quick description of each an every methods along with all needed references so that the interested reader might get an up-to-date list of papers.
This documentation, relatively exhaustive, aims at introducing methods both from their usefulness and from their implementation, including their interface (classes, inheriting, dependencies...) along with their options. Each and every module is introduced in a separated chapter after a general introduction of the platform and its organisation. This documentations contains a very large number exemples, refered to as use-cases, to illustrate how to handle the platform and represent the results.
This documentation, relatively exhaustive, aims at introducing methods both from their usefulness and from their implementation, including their interface (classes, inheriting, dependencies...) along with their options. Each and every module is introduced in a separated chapter after a general introduction of the platform and its organisation. This documentations contains a very large number exemples, refered to as use-cases, to illustrate how to handle the platform and represent the results.
The developer's manual is a detailled description of the method in term of implementation and is directly taken out of the code itself, as it is extracted from the comments written by the developers. This extraction is made using Doxygen, and is generated only during the installation of the Uranie platform. This aspect is discussed in the FAQ.
This documentation level aims at introducing the methods, from a very theoretical point of view. This is the main addition of this documentation: it provides a quick description of each an every methods along with all needed references so that the interested reader might get an up-to-date list of papers.
This documentation, relatively exhaustive, aims at introducing methods both from their usefulness and from their implementation, including their interface (classes, inheriting, dependencies...) along with their options. Each and every module is introduced in a separated chapter after a general introduction of the platform and its organisation. This documentations contains a very large number exemples, refered to as use-cases, to illustrate how to handle the platform and represent the results.
This documentation, relatively exhaustive, aims at introducing methods both from their usefulness and from their implementation, including their interface (classes, inheriting, dependencies...) along with their options. Each and every module is introduced in a separated chapter after a general introduction of the platform and its organisation. This documentations contains a very large number exemples, refered to as use-cases, to illustrate how to handle the platform and represent the results.