Documentation

Documentation of Awali is a bit sparse at the moment. We have focused so far on Getting Started documents explaining how to use Awalipy and Cora, which are the most user-friendly interfaces to Awali. These document are Jupyter notebooks. One can either read these notebooks under their html transcription or to download them and execute them in a Jupyter window.

Getting Started

• Jupyter/Python layer
  • Edition, visualisation and traversal of boolean automata: view as html or download as Jupyter notebook.
  • Edition, visualisation and traversal of boolean transducers: view as html or download as Jupyter notebook.
  • Edition, visualisation and traversal of weighted automata: view as html or download as Jupyter notebook.
  • Classical Transformations about graphs: view as html or download as Jupyter notebook.
  • Classical Transformations about boolean automata: view as html or download as Jupyter notebook.
  • Introduction to (weighted) rational expressions: view as html or download as Jupyter notebook.
• Cora
  • Getting Started With Cora: view as html or download as Jupyter notebook.
• Dynamically typed C++ layer
  • A first program to be compiled with awalidyn library

All aforementioned documents may be found in the tarball, in subdirectory awalidoc/GettingStarted.

Examples

Aside from the ones given in the previous section, we provide with each layer a few examples on how to use it; they are located in directories:

• awalipy/examples,
• awali/dyn/examples, and
• awali/sttc/examples.

Doxygen API documentation (C++ layers)

We use Doxygen to document the C++ API of Awali; it is available online at http://doxygen.vaucanson-project.org/.
Note that the Doxygen documentation is still in construction.

Doxygen API may also be generated locally by executing command make doxygen in directory _build (created as in section Compilation and Installation); off course Doxygen must then be installed.

Python API

In the Python layer, each function is documented with docstrings. This help may be displayed thanks to the built-in function help; for instance, the help for the function load may be displayed as follows.

  help(awalipy.load)

Dernière Last modification: 11 Janvier January 2022