.. _start_api_reports:

.. currentmodule:: iode


#############
API Reference
#############

******************
Execution Commands
******************

    +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
    | Command                             | Python                                                                                                                                          | Description                                               |
    +=====================================+=================================================================================================================================================+===========================================================+
    | :ref:`$abort <abort>`               | `exit() <https://docs.python.org/3/library/sys.html#sys.exit>`_                                                                                 | interrupts the report (current and upper levels)          |
    +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
    | :ref:`$ask <ask>`                   | `input(prompt) <https://docs.python.org/3/library/functions.html#input>`_                                                                       | prompts a question                                        |
    +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
    | :ref:`$beep <beep>`                 | will not be implemented                                                                                                                         | produces a beep sound                                     |
    +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
    | :ref:`$chdir <chdir>`               | `os.chdir(path) <https://docs.python.org/3/library/os.html#os.chdir>`_ [#f1]_                                                                   | changes the current directory                             |
    +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
    | :ref:`$debug <debug>`               | to be implemented                                                                                                                               | indicates the file and line currently being executed      |
    +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
    | :ref:`$define <define>`             | `my_variable = value <https://docs.python.org/3/tutorial/introduction.html#using-python-as-a-calculator>`_                                      | defines a macro                                           |
    +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
    | :ref:`$foreach <foreach>`           | `for item in iterable <https://docs.python.org/3/tutorial/controlflow.html#for-statements>`_                                                    | loops over a list of values                               |
    +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
    | :ref:`$goto <goto>`                 | not supported by Python                                                                                                                         | (un)conditional branch to a label                         |
    +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
    | :ref:`$incrtime <incrtime>`         | :func:`increment_t`                                                                                                                             | | increments the *current period* `t` (default is 1)      |
    |                                     |                                                                                                                                                 | | used when evaluating a LEC expression                   |
    +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
    | :ref:`$indent <indent>`             | | No equivalent (Python                                                                                                                         | enables or disables indentation                           |
    |                                     | | IS indentation-sensitive)                                                                                                                     |                                                           |
    +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
    | :ref:`$label <label>`               | not supported by Python                                                                                                                         | marks a branch point                                      |
    +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
    | :ref:`$maximize <maximize>`         |                                                                                                                                                 | maximizes the IODE window (OLD interface)                 |
    +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
    | :ref:`$minimize <minimize>`         |                                                                                                                                                 | minimizes the IODE window (OLD interface)                 |
    +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
    | :ref:`$mkdir <mkdir>`               | `os.mkdir(path) <https://docs.python.org/3/library/os.html#os.mkdir>`_ [#f1]_                                                                   | creates a new directory                                   |
    +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
    | :ref:`$multiline <multiline>`       | use backslash \\                                                                                                                                | enables or disables multiple lines                        |
    +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
    | :ref:`$msg <msg>`                   | `print(message) <https://docs.python.org/3/library/functions.html#print>`_                                                                      | displays a message and waits for a key press              |
    +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
    | :ref:`$next <next>`                 | no need                                                                                                                                         | ends a loop                                               |
    +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
    | :ref:`$noparsing <noparsing>`       |                                                                                                                                                 | | enables or disables parsing of text                     |
    |                                     |                                                                                                                                                 | | between backquotes                                      |
    +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
    | :ref:`$procdef <procdef>`           | `def function_name(...) <https://docs.python.org/3/tutorial/controlflow.html#defining-functions>`_                                              | defines a procedure (user defined function)               |
    +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
    | :ref:`$procend <procend>`           | No need                                                                                                                                         | ends the definition of a procedure                        |
    +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
    | :ref:`$procexec <procexec>`         | `function_name(arguments) <https://docs.python.org/3/tutorial/controlflow.html#defining-functions>`_                                            | executes a procedure                                      |
    +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
    | :ref:`$onerror <onerror>`           | to be implemented                                                                                                                               | action to take in case of error                           |
    +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
    | :ref:`$prompt <prompt>`             | `input(prompt) <https://docs.python.org/3/library/functions.html#input>`_                                                                       | defines a macro by prompting the user                     |
    +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
    | :ref:`$quit <quit>`                 | `exit() <https://docs.python.org/3/library/sys.html#sys.exit>`_                                                                                 | exits IODE                                                |
    +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
    | :ref:`$repeat <repeat>`             | `for item in iterable <https://docs.python.org/3/tutorial/controlflow.html#for-statements>`_                                                    | loops over the arguments                                  |
    +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
    | :ref:`$repeatstring <repeatstring>` |                                                                                                                                                 | defines the characters to be replaced in `$repeat`        |
    +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
    | :ref:`$return <return>`             | `return value <https://docs.python.org/3/tutorial/controlflow.html#defining-functions>`_                                                        | exits the current report                                  |
    +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
    | :ref:`$rmdir <rmdir>`               | `os.rmdir(path) <https://docs.python.org/3/library/os.rmdir>`_ [#f1]_                                                                           | deletes an empty directory                                |
    +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
    | :ref:`$settime <settime>`           | :func:`set_t`                                                                                                                                   | sets the variable `t`                                     |
    +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
    | :ref:`$shift <shift>`               | no equivalent in Python                                                                                                                         | shifts the report arguments one position to the left      |
    +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
    | :ref:`$show <show>`                 | `print(variable) <https://docs.python.org/3/library/functions.html#print>`_                                                                     | displays a message at the bottom of the screen            |
    +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
    | :ref:`$sleep <sleep>`               | `time.sleep(seconds) <https://docs.python.org/3/library/time.html#time.sleep>`_ [#f2]_                                                          | pauses the process for a short period                     |
    +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
    | :ref:`$system <system>`             | `os.system(command) <https://docs.python.org/3/library/os.html#os.system>`_ [#f1]_                                                              | executes a system command                                 |
    +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+
    | :ref:`$vseps <vseps>`               | `text.split(separators) <https://docs.python.org/3/library/stdtypes.html#str.split>`_                                                           | | redefines the separators used by `@vdrop()`,            |
    |                                     |                                                                                                                                                 | | `@vtake()` and `@vcount()`                              |
    +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+

.. [#f1] Assuming module ``os`` is imported.
.. [#f2] Assuming module ``time`` is imported.

**************
IODE Functions
**************

=======
Strings
=======

    +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
    | Function                                    | Python                                                                                                                 | Description                                                    |
    +=============================================+========================================================================================================================+================================================================+
    | :ref:`@upper(text) <upper>`                 | `txt.upper() <https://docs.python.org/3/library/stdtypes.html#str.upper>`_                                             | converts text to uppercase                                     |
    +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
    | :ref:`@lower(text) <lower>`                 | `txt.lower() <https://docs.python.org/3/library/stdtypes.html#str.lower>`_                                             | converts text to lowercase                                     |
    +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
    | :ref:`@replace(string, from, to) <replace>` | `txt.replace(old, new) <https://docs.python.org/3/library/stdtypes.html#str.replace>`_                                 | substitutes one text for another                               |
    +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
    | :ref:`@fmt(val, fmt) <fmt>`                 | | see `printf-style String <https://docs.python.org/3/library/stdtypes.html#printf-style-string-formatting>`_          | formats a number                                               |
    |                                             | | `Formatting <https://docs.python.org/3/library/stdtypes.html#printf-style-string-formatting>`_                       |                                                                |
    +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
    | :ref:`@take(n, string) <take>`              | `txt[:n] <https://docs.python.org/3/library/stdtypes.html#sequence-types-list-tuple-range>`_                           | | extracts the first n characters of string.                   |
    |                                             |                                                                                                                        | | If n is negative, extracts the last n characters.            |
    +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
    | :ref:`@drop(n, string) <drop>`              | `txt[n:] <https://docs.python.org/3/library/stdtypes.html#sequence-types-list-tuple-range>`_                           | | removes the first n characters of string.                    |
    |                                             |                                                                                                                        | | If n is negative, removes the last n characters.             |
    +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
    | :ref:`@count(string) <count>`               | `len(txt.split(',')) <https://docs.python.org/3/library/stdtypes.html#str.split>`_                                     | | returns the number of elements in string                     |
    |                                             |                                                                                                                        | | (separated by commas)                                        |
    +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
    | :ref:`@index(n, list) <index>`              | `split_list(list_txt)[n-1] <https://docs.python.org/3/library/stdtypes.html#sequence-types-list-tuple-range>`_         | returns the nth element of list                                |
    +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
    | :ref:`@sqz(string) <sqz>`                   | `txt.replace(' ', '') <https://docs.python.org/3/library/stdtypes.html#str.replace>`_                                  | removes spaces from string                                     |
    +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
    | :ref:`@strip(string) <strip>`               | `txt.strip() <https://docs.python.org/3/library/stdtypes.html#str.strip>`_                                             | removes trailing spaces from string                            |
    +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
    | :ref:`@ansi(text) <ansi>`                   | see `String Methods <https://docs.python.org/3/library/stdtypes.html#string-methods>`_                                 | converts an Ascii text to Ansi                                 |
    +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
    | :ref:`@equal(t1, t2) <equal>`               | `t1 == t2  <https://docs.python.org/3/library/stdtypes.html#comparisons>`_                                             | | compares t1 and t2.                                          |
    |                                             |                                                                                                                        | | Returns 1 if equal, 0 otherwise                              |
    +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+
    | :ref:`@void(t1, ...) <void>`                | will not be implemented                                                                                                | returns no text, whatever the arguments                        |
    +---------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------+

===============
List Of Strings 
===============

    +--------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------+
    | Function                       | Python                                                                                         | Description                               |
    +================================+================================================================================================+===========================================+
    | :ref:`@vtake(n, list) <vtake>` | `list_txt.split(separators)[:n] <https://docs.python.org/3/library/stdtypes.html#str.split>`_  | | take the first n elements of the list   |
    |                                |                                                                                                | | (or last n elements if n is negative)   |
    +--------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------+
    | :ref:`@vdrop(n, list) <vdrop>` | `list_txt.split(separators)[n:] <https://docs.python.org/3/library/stdtypes.html#str.split>`_  | | drop the first n elements of the list   |
    |                                |                                                                                                | | (or last n elements if n is negative)   |
    +--------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------+
    | :ref:`@vcount(list) <vcount>`  | `len(list_txt.split(separators)) <https://docs.python.org/3/library/stdtypes.html#str.split>`_ | return the number of elements in the list |
    +--------------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------+

=====
Files 
=====

    +---------------------------------------------+---------------------------------------------------------------------------------------------------+--------------------------------------+
    | Function                                    | Python                                                                                            | Description                          |
    +=============================================+===================================================================================================+======================================+
    | :ref:`@fdelete(filename) <fdelete>`         | `Path(filepath).unlink() <https://docs.python.org/3/library/pathlib.html#pathlib.Path.unlink>`_   | deletes the file filename            |
    +---------------------------------------------+---------------------------------------------------------------------------------------------------+--------------------------------------+
    | :ref:`@fappend(filename, string) <fappend>` | `open(filepath, 'a') <https://docs.python.org/3/library/functions.html#open>`_                    | writes the text to a file            |
    +---------------------------------------------+---------------------------------------------------------------------------------------------------+--------------------------------------+

===========
Directories
===========

    +----------------------------------------+----------------------------------------------------------------------------------------+----------------------------------------------------+
    | Function                               | Python                                                                                 | Description                                        |
    +========================================+========================================================================================+====================================================+
    | :ref:`@getdir() <getdir>`              | `os.getcwd() <https://docs.python.org/3/library/os.html#os.getcwd>`_                   | returns the current directory                      |
    +----------------------------------------+----------------------------------------------------------------------------------------+----------------------------------------------------+
    | :ref:`@chdir(dirname) <chdir>`         | `os.chdir(dirname) <https://docs.python.org/3/library/os.html#os.chdir>`_ [#f1]_       | | changes the current directory to dirname and     |
    |                                        |                                                                                        | | returns the new current directory                |
    +----------------------------------------+----------------------------------------------------------------------------------------+----------------------------------------------------+
    | :ref:`@mkdir(dirname) <mkdir>`         | `os.mkdir(dirname) <https://docs.python.org/3/library/os.html#os.mkdir>`_ [#f1]_       | creates a new directory dirname                    |
    +----------------------------------------+----------------------------------------------------------------------------------------+----------------------------------------------------+
    | :ref:`@rmdir(dirname) <rmdir>`         | `os.rmdir(dirname) <https://docs.python.org/3/library/os.html#os.rmdir>`_ [#f1]_       | deletes the directory dirname                      |
    +----------------------------------------+----------------------------------------------------------------------------------------+----------------------------------------------------+

===============
Dates And Times
===============

    +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+
    | Function                               | Python                                                                                                                       | Description                                 |
    +========================================+==============================================================================================================================+=============================================+
    | :ref:`@date([format]) <date>`          | | `d = datetime.now() <https://docs.python.org/3/library/datetime.html#datetime.datetime.now>`_ [#f4]_                       | returns the date                            |
    |                                        | | `d.strftime("%d/%m/%Y") <https://docs.python.org/3/library/datetime.html#datetime.datetime.now>`_                          |                                             |
    +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+
    | :ref:`@time([format]) <time>`          | | `d = datetime.now() <https://docs.python.org/3/library/datetime.html#datetime.datetime.now>`_ [#f4]_                       | returns the time                            |
    |                                        | | `d.strftime("%H:%M:%S") <https://docs.python.org/3/library/datetime.html#datetime.datetime.now>`_                          |                                             |
    +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+
    | :ref:`@month(month, language) <month>` | | `d = datetime.date(year, month, day) <https://docs.python.org/3.9/library/datetime.html#strftime-and-strptime-behavior>`_  | | returns the text of the month             |
    |                                        | | `month = d.strftime("%B") <https://docs.python.org/3.9/library/datetime.html#strftime-and-strptime-behavior>`_             | | in the given language                     |
    +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+
    | :ref:`@ChronoReset() <chronoreset>`    | `start = time.time_ns() <https://docs.python.org/3/library/time.html#time.time_ns>`_ [#f3]_                                  | resets the timer to 0                       |
    +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+
    | :ref:`@ChronoGet() <chronoget>`        | `delta_t = time.time_ns() - start <https://docs.python.org/3/library/time.html#time.time_ns>`_ [#f3]_                        | | returns the elapsed time (in              |
    |                                        |                                                                                                                              | | msecs) since the last timer reset         |
    +----------------------------------------+------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+

.. [#f3] Assuming module ``time`` is imported.
.. [#f4] Assuming module ``datetime`` is imported.

================
Lists Of Objects
================

    +-----------------------------------------+-----------------------------------+--------------------------------------------------+
    | Function                                | Python                            | Description                                      |
    +=========================================+===================================+==================================================+
    | :ref:`@cexpand(pattern, ...) <cexpand>` | :meth:`Comments.get_names`        | returns the list of comments matching pattern    |
    +-----------------------------------------+-----------------------------------+--------------------------------------------------+
    | :ref:`@eexpand(pattern, ...) <eexpand>` | :meth:`Equations.get_names`       | returns the list of equations matching pattern   |
    +-----------------------------------------+-----------------------------------+--------------------------------------------------+
    | :ref:`@iexpand(pattern, ...) <iexpand>` | :meth:`Identities.get_names`      | returns the list of identities matching pattern  |
    +-----------------------------------------+-----------------------------------+--------------------------------------------------+
    | :ref:`@lexpand(pattern, ...) <lexpand>` | :meth:`Lists.get_names`           | returns the list of lists matching pattern       |
    +-----------------------------------------+-----------------------------------+--------------------------------------------------+
    | :ref:`@sexpand(pattern, ...) <sexpand>` | :meth:`Scalars.get_names`         | returns the list of scalars matching pattern     |
    +-----------------------------------------+-----------------------------------+--------------------------------------------------+
    | :ref:`@texpand(pattern, ...) <texpand>` | :meth:`Tables.get_names`          | returns the list of tables matching pattern      |
    +-----------------------------------------+-----------------------------------+--------------------------------------------------+
    | :ref:`@vexpand(pattern, ...) <vexpand>` | :meth:`Variables.get_names`       | returns the list of variables matching pattern   |
    +-----------------------------------------+-----------------------------------+--------------------------------------------------+
    | :ref:`@vliste(objname, ...) <vliste>`   | | :attr:`Equation.variables`      | | returns the list of variables in the           |
    |                                         | | :attr:`Equations.variables`     | | equation(s), identity(ies), table(s)           |
    |                                         | | :attr:`Identity.variables`      |                                                  |
    |                                         | | :attr:`Identities.variables`    |                                                  |
    |                                         | | :attr:`Table.variables`         |                                                  |
    |                                         | | :attr:`Tables.variables`        |                                                  |
    +-----------------------------------------+-----------------------------------+--------------------------------------------------+
    | :ref:`@sliste(objname, ...) <sliste>`   | | :attr:`Equation.coefficients`   | | returns the list of scalars in the             |
    |                                         | | :attr:`Equations.coefficients`  | | equation(s), identity(ies), table(s)           |
    |                                         | | :attr:`Identity.coefficients`   |                                                  |
    |                                         | | :attr:`Identities.coefficients` |                                                  |
    |                                         | | :attr:`Table.coefficients`      |                                                  |
    |                                         | | :attr:`Tables.coefficients`     |                                                  |
    +-----------------------------------------+-----------------------------------+--------------------------------------------------+

===============
Objects Content
===============

    +---------------------------------------------------+--------------------------------------------------+-----------------------------------------+
    | Function                                          | Python                                           | Description                             |
    +===================================================+==================================================+=========================================+
    | :ref:`@ttitle(tablename,tablename, ...) <ttitle>` | :attr:`Table.title`                              | returns the titles of the tables        |
    +---------------------------------------------------+--------------------------------------------------+-----------------------------------------+
    | :ref:`@srelax(sclname,sclname, ...) <srelax>`     | :attr:`Scalar.relax`                             | returns the relax value for scalars     |
    +---------------------------------------------------+--------------------------------------------------+-----------------------------------------+
    | :ref:`@sstderr(sclname,sclname, ...) <sstderr>`   | :attr:`Scalar.std`                               | returns the stderr value for scalars    |
    +---------------------------------------------------+--------------------------------------------------+-----------------------------------------+
    | :ref:`@cvalue(cmtname,cmtname, ...) <cvalue>`     | :meth:`comments[names] <Comments.__getitem__>`   | returns the content of a comments       |
    +---------------------------------------------------+--------------------------------------------------+-----------------------------------------+
    | :ref:`@vvalue(varname,varname, ...) <vvalue>`     | :meth:`variables[names] <Variables.__getitem__>` | returns the values of variables as text |
    +---------------------------------------------------+--------------------------------------------------+-----------------------------------------+
    | :ref:`@sample(B|E|) <sample>`                     | :attr:`Variables.sample`                         | | returns the (beginning/ending of) the |
    |                                                   |                                                  | | current sample as text                |
    +---------------------------------------------------+--------------------------------------------------+-----------------------------------------+

=========
Equations
=========

    +----------------------------------------------+---------------------------------+-------------------------------------+
    | Function                                     | Python                          | Description                         |
    +==============================================+=================================+=====================================+
    | :ref:`@evalue(eqname, eqname, ...) <evalue>` | :attr:`Equation.lec`            | returns the LEC text of an equation |
    +----------------------------------------------+---------------------------------+-------------------------------------+
    | :ref:`@eqsample(eqname) <eqsample>`          | :attr:`Equation.sample`         | | returns the estimation sample     |
    |                                              |                                 | | of the equation                   |
    +----------------------------------------------+---------------------------------+-------------------------------------+
    | :ref:`@eqsamplefrom(eqname) <eqsamplefrom>`  | | :attr:`Equation.sample` and   | | returns the *FROM* part of        |
    |                                              | | :attr:`Sample.start`          | | the estimation sample             |
    +----------------------------------------------+---------------------------------+-------------------------------------+
    | :ref:`@eqsampleto(eqname) <eqsampleto>`      | | :attr:`Equation.sample` and   | | returns the *TO* part of          |
    |                                              | | :attr:`Sample.end`            | | the estimation sample             |
    +----------------------------------------------+---------------------------------+-------------------------------------+
    | :ref:`@eqlhs(eqname) <eqlhs>`                | :meth:`Equation.split_equation` | | returns the left-hand side        |
    |                                              |                                 | | of an equation                    |
    +----------------------------------------------+---------------------------------+-------------------------------------+
    | :ref:`@eqrhs(eqname) <eqrhs>`                | :meth:`Equation.split_equation` | | returns the right-hand side       |
    |                                              |                                 | | of an equation                    |
    +----------------------------------------------+---------------------------------+-------------------------------------+

===========
Simulations
===========

    +-------------------------------------+-----------------------------------------------+------------------------------------------+
    | Function                            | Python                                        | Description                              |
    +=====================================+===============================================+==========================================+
    | :ref:`@SimEps() <simeps>`           | :attr:`Simulation.convergence_threshold`      | | returns the value of the convergence   |
    |                                     |                                               | | criterion used for the last simulation |
    +-------------------------------------+-----------------------------------------------+------------------------------------------+
    | :ref:`@SimRelax() <simrelax>`       | :attr:`Simulation.relax`                      | | returns the value of the relaxation    |
    |                                     |                                               | | parameter used for the last simulation |
    +-------------------------------------+-----------------------------------------------+------------------------------------------+
    | :ref:`@SimMaxit() <simmaxit>`       | :attr:`Simulation.max_nb_iterations`          | | returns the value of the maximum       |
    |                                     |                                               | | number of iterations used for the      |
    |                                     |                                               | | last simulation                        |
    +-------------------------------------+-----------------------------------------------+------------------------------------------+
    | :ref:`@SimNiter(period) <simniter>` | :meth:`Simulation.nb_iterations`              | | number of iterations required to solve |
    |                                     |                                               | | the model for year period              |
    +-------------------------------------+-----------------------------------------------+------------------------------------------+
    | :ref:`@SimNorm(period) <simnorm>`   | :meth:`Simulation.norm`                       | | convergence threshold reached when     |
    |                                     |                                               | | solving the model for year period      |
    +-------------------------------------+-----------------------------------------------+------------------------------------------+

*************
IODE Commands
*************

==========================
Report - Command Execution 
==========================

    +-------------------------------------------+-----------------------------------+------------------------------------------------------+
    | Command                                   | Python                            | Description                                          |
    +===========================================+===================================+======================================================+
    | :ref:`reportexec <reportexec>`            | :func:`execute_report`            | | executes an IODE report                            |
    |                                           |                                   | | (recursive, allows multiple levels of sub-reports) |
    +-------------------------------------------+-----------------------------------+------------------------------------------------------+
    |                                           | :func:`execute_command`           | executes an IODE command or function in Python       |
    +-------------------------------------------+-----------------------------------+------------------------------------------------------+

=====
Files
=====

    +---------------------------------------------+------------------------------------+--------------------------------------------------+
    | Function                                    | Python                             | Description                                      |
    +=============================================+====================================+==================================================+
    | :ref:`fileprint <fileprint>`                |                                    | prints a file to the defined printer             |
    +---------------------------------------------+------------------------------------+--------------------------------------------------+
    | :ref:`filedelete <filedelete>`              |                                    | deletes a file on disk with specific extensions  |
    +---------------------------------------------+------------------------------------+--------------------------------------------------+
    | :ref:`filerename <filerename>`              |                                    | renames a file on disk with specific extensions  |
    +---------------------------------------------+------------------------------------+--------------------------------------------------+
    | :ref:`filecopy <filecopy>`                  |                                    | copies a file on disk with specific extensions   |
    +---------------------------------------------+------------------------------------+--------------------------------------------------+
    | :ref:`SysCopyFile <syscopyfile>`            |                                    | copies any file on disk with any extension       |
    +---------------------------------------------+------------------------------------+--------------------------------------------------+
    | :ref:`SysMoveFile <sysmovefile>`            |                                    | renames any file on disk with any extension      |
    +---------------------------------------------+------------------------------------+--------------------------------------------------+
    | :ref:`SysDeleteFile <sysdeletefile>`        |                                    | deletes any file on disk with any extension      |
    +---------------------------------------------+------------------------------------+--------------------------------------------------+
    | :ref:`SysOemToAnsi <sysoemtoansi>`          |                                    | converts file encoding from OEM to ANSI          |
    +---------------------------------------------+------------------------------------+--------------------------------------------------+
    | :ref:`SysOemToUTF8 <sysoemtoutf8>`          |                                    | converts file encoding from OEM to UTF8          |
    +---------------------------------------------+------------------------------------+--------------------------------------------------+
    | :ref:`SysAnsiToOem <sysansitooem>`          |                                    | converts file encoding from ANSI to OEM          |
    +---------------------------------------------+------------------------------------+--------------------------------------------------+
    | :ref:`SysAnsiToUTF8 <sysansitoutf8>`        |                                    | converts file encoding from ANSI to UTF8         |
    +---------------------------------------------+------------------------------------+--------------------------------------------------+
    | :ref:`SysAppendFile <sysappendfile>`        |                                    | appends one file to another                      |
    +---------------------------------------------+------------------------------------+--------------------------------------------------+
    | :ref:`FileImportVar <fileimportvar>`        | :meth:`Variables.convert_file`     | | imports variables in various formats           |
    |                                             |                                    | | (DIF, ASCII, etc.)                             |
    +---------------------------------------------+------------------------------------+--------------------------------------------------+
    | :ref:`FileImportCmt <fileimportcmt>`        | :meth:`Comments.convert_file`      | | imports comments in various formats            |
    |                                             |                                    | | (DIF, ASCII, etc.)                             |
    +---------------------------------------------+------------------------------------+--------------------------------------------------+

====================
Workspace Operations
====================

    +---------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------------------------------+
    | Function                                    | Python                                                                                         | Description                                       |
    +=============================================+================================================================================================+===================================================+
    | :ref:`WsLoad <wsload>`                      | :meth:`~Comments.load`                                                                         | loads a workspace cmt, ..., var from a file       |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------------------------------+
    | :ref:`WsCopy <wscopy>`                      | :meth:`~Comments.copy_into`                                                                    | copies a workspace cmt, ..., var from a file      |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------------------------------+
    | :ref:`WsMerge <wsmerge>`                    | :meth:`~Comments.merge_from`                                                                   | | merges one or several IODE data files           |
    |                                             |                                                                                                | | into a workspace cmt, ..., var                  |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------------------------------+
    | :ref:`WsClear <wsclear>`                    | :meth:`~Comments.clear`                                                                        | deletes a workspace cmt, ..., var                 |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------------------------------+
    | :ref:`WsClearAll <wsclearall>`              |                                                                                                | clears all workspaces                             |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------------------------------+
    | :ref:`WsDescr <wsdescr>`                    | :attr:`~Comments.description`                                                                  | describes a workspace cmt, ..., var               |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------------------------------+
    | :ref:`WsSave <wssave>`                      | :meth:`~Comments.save`                                                                         | saves a workspace cmt, ..., var to a file         |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------------------------------+
    | :ref:`WsSaveCmp <wssavecmp>`                | :meth:`~Comments.save`                                                                         | | saves a workspace cmt, ..., var to a file       |
    |                                             |                                                                                                | | in compressed form                              |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------------------------------+
    | :ref:`WsSample <wssample>`                  | :attr:`Variables.sample`                                                                       | | changes the sample of the *Variables*           |
    |                                             |                                                                                                | | workspace                                       |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------------------------------+
    | :ref:`WsExtrapolate <wsextrapolate>`        | :meth:`Variables.extrapolate`                                                                  | extends series by extrapolation                   |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------------------------------+
    | :ref:`WsLtohStock <wsltohstock>`            | :meth:`Variables.low_to_high`                                                                  | builds higher frequency series for stocks         |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------------------------------+
    | :ref:`WsLtohFlow <wsltohflow>`              | :meth:`Variables.low_to_high`                                                                  | builds higher frequency series for flows          |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------------------------------+
    | :ref:`WsHtolSum <wshtolsum>`                | :meth:`Variables.high_to_low`                                                                  | builds lower frequency series (sum)               |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------------------------------+
    | :ref:`WsHtolMean <wshtolmean>`              | :meth:`Variables.high_to_low`                                                                  | builds lower frequency series (mean)              |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------------------------------+
    | :ref:`WsHtolLast <wshtollast>`              | :meth:`Variables.high_to_low`                                                                  | | builds lower frequency series                   |
    |                                             |                                                                                                | | (last observation)                              |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------------------------------+
    | :ref:`WsSeasonAdj <wsseasonadj>`            | :meth:`Variables.seasonal_adjustment`                                                          | builds seasonally adjusted series                 |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------------------------------+
    | :ref:`WsSeasAdj <wsseasadj>`                | :meth:`Variables.seasonal_adjustment`                                                          | selects the seasonal adjustment criterion         |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------------------------------+
    | :ref:`WsTrend <wstrend>`                    | :meth:`Variables.trend_correction`                                                             | | computes trend series (Hodrick-Prescott)        |
    |                                             |                                                                                                | | using log transformation                        |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------------------------------+
    | :ref:`WsTrendStd <wstrendstd>`              | :meth:`Variables.trend_correction`                                                             | | computes trend series (Hodrick-Prescott)        |
    |                                             |                                                                                                | | using the standard method                       |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------------------------------+
    | :ref:`WsImport <wsimport>`                  | :meth:`~Comments.load`                                                                         | imports an ASCII file                             |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------------------------------+
    | :ref:`WsExport <wsexport>`                  | :meth:`~Comments.save`                                                                         | exports to a file in ASCII format                 |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------------------------------+
    | :ref:`WsImportEviews <wsimporteviews>`      | will not be implemented                                                                        | imports E-Views equations and scalars             |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------------------------------+
    | :ref:`CsvSave <csvsave>`                    | | :meth:`Variables.to_frame` and                                                               | saves a workspace in csv format                   |
    |                                             | | `pandas to_csv <https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.to_csv.html>`_ |                                                   |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------------------------------+
    | :ref:`CsvDigits <csvdigits>`                | | :meth:`Variables.to_frame` and                                                               | sets the number of decimals in CSV files          |
    |                                             | | `pandas to_csv <https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.to_csv.html>`_ |                                                   |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------------------------------+
    | :ref:`CsvSep <csvsep>`                      | | :meth:`Variables.to_frame` and                                                               | sets the cell separator in CSV files              |
    |                                             | | `pandas to_csv <https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.to_csv.html>`_ |                                                   |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------------------------------+
    | :ref:`CsvDec <csvdec>`                      | | :meth:`Variables.to_frame` and                                                               | sets the decimal separator in CSV files           |
    |                                             | | `pandas to_csv <https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.to_csv.html>`_ |                                                   |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------------------------------+
    | :ref:`CsvNaN <csvnan>`                      | | :meth:`Variables.to_frame` and                                                               | | sets the text indicating an undefined value     |
    |                                             | | `pandas to_csv <https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.to_csv.html>`_ | | in CSV files                                    |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------------------------------+
    | :ref:`CsvAxes <csvaxes>`                    | | :meth:`Variables.to_frame` and                                                               | | sets the name of the variable axis              |
    |                                             | | `pandas to_csv <https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.to_csv.html>`_ | | in CSV files                                    |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+---------------------------------------------------+ 

===============
Data Operations
===============

    +---------------------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------------------------+
    | Command                                     | Python                                                                                         | Description                                            |
    +=============================================+================================================================================================+========================================================+
    | :ref:`datacreate <datacreate>`              | | :meth:`name in workspace <Comments.__contains__>` and                                        | creates an object (cmt, ..., var)                      |
    |                                             | | ``workspace[name]`` for                                                                      |                                                        |
    |                                             | | :meth:`comments <Comments.__setitem__>`, :meth:`equations <Equations.__setitem__>`,          |                                                        |
    |                                             | | :meth:`identities <Identities.__setitem__>`, :meth:`lists <Lists.__setitem__>`,              |                                                        |
    |                                             | | :meth:`scalars <Scalars.__setitem__>`, :meth:`tables <Tables.__setitem__>` and               |                                                        |
    |                                             | | :meth:`variables <Variables.__setitem__>`                                                    |                                                        |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------------------------+
    | :ref:`datadelete <datadelete>`              | :meth:`del workspace[name] <Comments.__delitem__>`                                             | deletes an object (cmt, ..., var)                      |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------------------------+
    | :ref:`dataexist <dataexist>`                | :meth:`name in workspace <Comments.__contains__>`                                              | tests for the existence of an object (cmt, ... var)    |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------------------------+
    | :ref:`dataedit <dataedit>`                  | | ``workspace[name] = value`` for                                                              | edits an object (cmt, ..., var)                        |
    |                                             | | :meth:`comments <Comments.__setitem__>`, :meth:`equations <Equations.__setitem__>`,          |                                                        |
    |                                             | | :meth:`identities <Identities.__setitem__>`, :meth:`lists <Lists.__setitem__>`,              |                                                        |
    |                                             | | :meth:`scalars <Scalars.__setitem__>`, :meth:`tables <Tables.__setitem__>` and               |                                                        |
    |                                             | | :meth:`variables <Variables.__setitem__>`                                                    |                                                        |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------------------------+
    | :ref:`dataupdate <dataupdate>`              | | ``workspace[name] = value`` for                                                              | modifies an object (cmt, ..., var)                     |
    |                                             | | :meth:`comments <Comments.__setitem__>`, :meth:`equations <Equations.__setitem__>`,          |                                                        |
    |                                             | | :meth:`identities <Identities.__setitem__>`, :meth:`lists <Lists.__setitem__>`,              |                                                        |
    |                                             | | :meth:`scalars <Scalars.__setitem__>`, :meth:`tables <Tables.__setitem__>` and               |                                                        |
    |                                             | | :meth:`variables <Variables.__setitem__>`                                                    |                                                        |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------------------------+
    | :ref:`dataappend <dataappend>`              | | ``workspace[name] = workspace[name] + value`` for                                            | appends an object (cmt / lst)                          |
    |                                             | | :meth:`comments <Comments.__setitem__>` and :meth:`lists <Lists.__setitem__>`                |                                                        |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------------------------+
    | :ref:`dataduplicate <dataduplicate>`        | | ``workspace[new_name] = workspace[name]`` for                                                | | duplicates an object (cmt, ..., var)                 |
    |                                             | | :meth:`comments <Comments.__setitem__>`, :meth:`identities <Identities.__setitem__>`,        | | (an equation cannot be duplicated)                   |
    |                                             | | :meth:`lists <Lists.__setitem__>`, :meth:`scalars <Scalars.__setitem__>`,                    |                                                        |
    |                                             | | :meth:`tables <Tables.__setitem__>` and :meth:`variables <Variables.__setitem__>`            |                                                        |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------------------------+
    | :ref:`datarename <datarename>`              | :meth:`~Comments.rename`                                                                       | renames an object (cmt, ..., var)                      |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------------------------+
    | :ref:`datasearch <datasearch>`              | :meth:`~Comments.search`                                                                       | searches for an object (cmt, ..., var)                 |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------------------------+
    | :ref:`datascan <datascan>`                  | | :attr:`~Equation.coefficients` and                                                           | scans the objects (eqs / idt / tbl)                    |
    |                                             | | :attr:`~Equation.variables`                                                                  |                                                        |
    |                                             | | (`Equation`, `Identity` and `Table`)                                                         |                                                        |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------------------------+
    | :ref:`datalistXxx <datalist>`               | :meth:`~Comments.get_names`                                                                    | creates a list of objects given a pattern              |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------------------------+
    | :ref:`datalistsort <datalistsort>`          | `sorted with Python lists                                                                      | sorts a list in alphabetical order                     |
    |                                             | <https://docs.python.org/3/library/functions.html#sorted>`_                                    |                                                        |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------------------------+
    | :ref:`datacompareEps <datacompareeps>`      | :attr:`Variables.threshold`                                                                    | | sets the equality threshold for variable             |
    |                                             |                                                                                                | | comparison                                           |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------------------------+
    | :ref:`datacompareXxx <datacompare>`         | :meth:`~Comments.compare`                                                                      | | compares the workspace and a file and                |
    |                                             |                                                                                                | | creates lists (*OLD*, *NEW*, *SAME* and *CHANGED*)   |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------------------------+
    | :ref:`datacalclst <datacalclst>`            | | `union, intersection and <https://docs.python.org/3/tutorial/datastructures.html#sets>`_     | performs logical operations on lists                   |
    |                                             | | `difference with Python sets <https://docs.python.org/3/tutorial/datastructures.html#sets>`_ |                                                        |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------------------------+
    | :ref:`datacalcvar <datacalcvar>`            | :meth:`variables[name] = "LEC expression" <Variables.__setitem__>`                             | calculates a variable based on a LEC expression        |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------------------------+
    | :ref:`datadisplaygraph <datadisplaygraph>`  | | :meth:`Variables.to_frame` and                                                               | displays a graph based on series                       |
    |                                             | | `pandas visualization <https://pandas.pydata.org/docs/user_guide/visualization.html>`_       |                                                        |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------------------------+
    | :ref:`datasavegraph <datasavegraph>`        | | :meth:`Variables.to_frame` and                                                               | saves a graph calculated from series                   |
    |                                             | | `pandas visualization <https://pandas.pydata.org/docs/user_guide/visualization.html>`_       |                                                        |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------------------------+
    | :ref:`datawidthvar <datawidthvar>`          | via GUI                                                                                        | sets the column width for editing series               |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------------------------+
    | :ref:`datandecvar <datandecvar>`            | via GUI                                                                                        | sets the number of decimals for editing series         |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------------------------+
    | :ref:`datamodevar <datamodevar>`            | :attr:`Variables.mode`                                                                         | sets the mode for editing series                       |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------------------------+
    | :ref:`datastartvar <datastartvar>`          | via GUI                                                                                        | sets the first period for editing series               |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------------------------+
    | :ref:`datawidthtbl <datawidthtbl>`          | via GUI                                                                                        | sets the column width for editing tables               |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------------------------+
    | :ref:`datawidthscl <datawidthscl>`          | via GUI                                                                                        | sets the column width for editing scalars              |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------------------------+
    | :ref:`datandecscl <datandecscl>`            | via GUI                                                                                        | sets the number of decimals for editing scalars        |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------------------------+
    | :ref:`dataeditcnf <dataeditcnf>`            | via GUI                                                                                        | changes the editing options for variables              |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------------------------+
    | :ref:`datarasvar <datarasvar>`              | :meth:`Variables.execute_RAS`                                                                  | RAS method for completing a matrix of series           |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------------------------+
    | :ref:`datapatternXXX <datapattern>`         | :meth:`~Comments.get_names`                                                                    | creates lists of names from a pattern                  |
    +---------------------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------------------------+

=========
Equations
=========

    +---------------------------------------------+------------------------------------------------------------+-------------------------------------------------+
    | Command                                     | Python                                                     | Description                                     |
    +=============================================+============================================================+=================================================+
    | :ref:`EqsEstimate <eqsestimate>`            | | :meth:`Equation.estimate` and                            | estimates an equation or a block of equations   |
    |                                             | | :meth:`Equations.estimate`                               |                                                 |
    +---------------------------------------------+------------------------------------------------------------+-------------------------------------------------+
    | :ref:`EqsStepWise <eqsstepwise>`            | | :meth:`Equation.estimate_step_wise` and                  | | estimates a block of equations and searches   |
    |                                             | | :meth:`Equations.estimate_step_wise`                     | | for the best possible tests for all possible  |
    |                                             |                                                            | | combinations of coefficients                  |
    +---------------------------------------------+------------------------------------------------------------+-------------------------------------------------+
    | :ref:`EqsSetCmt <eqssetcmt>`                | :attr:`Equation.comment`                                   | sets comment to an equation                     |
    +---------------------------------------------+------------------------------------------------------------+-------------------------------------------------+
    | :ref:`EqsSetSample <eqssetsample>`          | :attr:`Equation.sample`                                    | sets sample to an equation                      |
    +---------------------------------------------+------------------------------------------------------------+-------------------------------------------------+
    | :ref:`EqsSetMethod <eqssetmethod>`          | :attr:`Equation.method`                                    | sets estimation method for an equation          |
    +---------------------------------------------+------------------------------------------------------------+-------------------------------------------------+
    | :ref:`EqsSetInstrs <eqssetinstrs>`          | :attr:`Equation.instruments`                               | sets instruments for an equation                |
    +---------------------------------------------+------------------------------------------------------------+-------------------------------------------------+
    | :ref:`EqsSetBloc <eqssetbloc>`              | :attr:`Equation.block`                                     | sets bloc membership for an equation            |
    +---------------------------------------------+------------------------------------------------------------+-------------------------------------------------+

=====================
Printer Configuration
=====================

    +--------------------------------------------------+--------------------------------------+------------------------------------------------------------+
    | Command                                          | Python                               | Description                                                |
    +==================================================+======================================+============================================================+
    | :ref:`printdest <printdest>`                     |                                      | sets the print destination                                 |
    +--------------------------------------------------+--------------------------------------+------------------------------------------------------------+
    | :ref:`printdestnew <printdestnew>`               |                                      | sets the print destination and resets the print file       |
    +--------------------------------------------------+--------------------------------------+------------------------------------------------------------+
    | :ref:`printnbdec <printnbdec>`                   |                                      | sets the number of decimals for printing                   |
    +--------------------------------------------------+--------------------------------------+------------------------------------------------------------+
    | :ref:`printlang <printlang>`                     |                                      | sets the default language for printing                     |
    +--------------------------------------------------+--------------------------------------+------------------------------------------------------------+
    | :ref:`PrintA2mAppend <printa2mappend>`           |                                      | prevents the a2m file from being cleared before printing   |
    +--------------------------------------------------+--------------------------------------+------------------------------------------------------------+
    | :ref:`PrintFont <printfont>`                     |                                      | sets the font for printing                                 |
    +--------------------------------------------------+--------------------------------------+------------------------------------------------------------+
    | :ref:`PrintTableFont <printtablefont>`           |                                      | sets the font for tables                                   |
    +--------------------------------------------------+--------------------------------------+------------------------------------------------------------+
    | :ref:`PrintTableBox <printtablebox>`             |                                      | sets the border width for tables                           |
    +--------------------------------------------------+--------------------------------------+------------------------------------------------------------+
    | :ref:`PrintTableColor <printtablecolor>`         |                                      | enables or disables color in tables                        |
    +--------------------------------------------------+--------------------------------------+------------------------------------------------------------+
    | :ref:`PrintTableWidth <printtablewidth>`         |                                      | sets the width of tables in Frame and Rtf                  |
    +--------------------------------------------------+--------------------------------------+------------------------------------------------------------+
    | :ref:`PrintTableBreak <printtablebreak>`         |                                      | enables or disables table breaks across multiple pages     |
    +--------------------------------------------------+--------------------------------------+------------------------------------------------------------+
    | :ref:`PrintTablePage <printtablepage>`           |                                      | forces a page break before each table                      |
    +--------------------------------------------------+--------------------------------------+------------------------------------------------------------+
    | :ref:`PrintBackground <printbackground>`         |                                      | sets the background color (tables and charts)              |
    +--------------------------------------------------+--------------------------------------+------------------------------------------------------------+
    | :ref:`PrintGraphBox <printgraphbox>`             |                                      | sets the border width for charts                           |
    +--------------------------------------------------+--------------------------------------+------------------------------------------------------------+
    | :ref:`PrintGraphBrush <printgraphbrush>`         |                                      | sets the background density for charts                     |
    +--------------------------------------------------+--------------------------------------+------------------------------------------------------------+
    | :ref:`PrintGraphSize <printgraphsize>`           |                                      | sets the size of charts                                    |
    +--------------------------------------------------+--------------------------------------+------------------------------------------------------------+
    | :ref:`PrintGraphPage <printgraphpage>`           |                                      | forces a page break before each chart                      |
    +--------------------------------------------------+--------------------------------------+------------------------------------------------------------+
    | :ref:`PrintRtfHelp <printrtfhelp>`               |                                      | generates an RTF file for Windows help                     |
    +--------------------------------------------------+--------------------------------------+------------------------------------------------------------+
    | :ref:`PrintRtfTopic <printrtftopic>`             |                                      | creates a new topic (Windows Help)                         |
    +--------------------------------------------------+--------------------------------------+------------------------------------------------------------+
    | :ref:`PrintRtfLevel <printrtflevel>`             |                                      | changes the hierarchical level of the following topics     |
    +--------------------------------------------------+--------------------------------------+------------------------------------------------------------+
    | :ref:`PrintRtfTitle <printrtftitle>`             |                                      | sets the title for Windows help                            |
    +--------------------------------------------------+--------------------------------------+------------------------------------------------------------+
    | :ref:`PrintRtfCopyright <printrtfcopyright>`     |                                      | sets the copyright text for Windows help                   |
    +--------------------------------------------------+--------------------------------------+------------------------------------------------------------+
    | :ref:`PrintHtmlHelp <printhtmlhelp>`             |                                      | generates an HTML file for HtmlHelp                        |
    +--------------------------------------------------+--------------------------------------+------------------------------------------------------------+
    | :ref:`PrintHtmlStrip <printhtmlstrip>`           |                                      | | when generating an HTML file (A2mToHtml), does not       |
    |                                                  |                                      | | generate a header or footer                              |
    +--------------------------------------------------+--------------------------------------+------------------------------------------------------------+
    | :ref:`PrintParanum <printparanum>`               |                                      | enables numbering of headings                              |
    +--------------------------------------------------+--------------------------------------+------------------------------------------------------------+
    | :ref:`PrintPageHeader <printpageheader>`         |                                      | sets the page header for printed pages                     |
    +--------------------------------------------------+--------------------------------------+------------------------------------------------------------+
    | :ref:`PrintPageFooter <printpagefooter>`         |                                      | sets the page footer for printed pages                     |
    +--------------------------------------------------+--------------------------------------+------------------------------------------------------------+
    | :ref:`SetPrinter <setprinter>`                   |                                      | sets the default printer                                   |
    +--------------------------------------------------+--------------------------------------+------------------------------------------------------------+
    | :ref:`PrintOrientation <printorientation>`       |                                      | sets the paper orientation in the printer                  |
    +--------------------------------------------------+--------------------------------------+------------------------------------------------------------+
    | :ref:`PrintDuplex <printduplex>`                 |                                      | sets the duplex (double-sided) mode of the printer         |
    +--------------------------------------------------+--------------------------------------+------------------------------------------------------------+
    | :ref:`PrintGIFBackColor <printgifbackcolor>`     |                                      | sets the background color for charts                       |
    +--------------------------------------------------+--------------------------------------+------------------------------------------------------------+
    | :ref:`PrintGIFTransColor <printgiftranscolor>`   |                                      | sets the color considered as "transparent"                 |
    +--------------------------------------------------+--------------------------------------+------------------------------------------------------------+
    | :ref:`PrintGIFTransparent <printgiftransparent>` |                                      | indicates if the GIF file should be transparent            |
    +--------------------------------------------------+--------------------------------------+------------------------------------------------------------+
    | :ref:`PrintGIFInterlaced <printgifinterlaced>`   |                                      | indicates if the GIF file should be interlaced             |
    +--------------------------------------------------+--------------------------------------+------------------------------------------------------------+
    | :ref:`PrintGIFFilled <printgiffilled>`           |                                      | indicates whether to fill bars in bar charts               |
    +--------------------------------------------------+--------------------------------------+------------------------------------------------------------+
    | :ref:`PrintGIFFont <printgiffont>`               |                                      | specifies the font number to use                           |
    +--------------------------------------------------+--------------------------------------+------------------------------------------------------------+

===============
Object Printing
===============

    +---------------------------------------------+-------------------------------------------+------------------------------------------------------+
    | Command                                     | Python                                    | Description                                          |
    +=============================================+===========================================+======================================================+
    | :ref:`printobjdef <printobjdef>`            | :meth:`Comments.print_to_file`            | prints a definition of an object cmt, ..., var       |
    +---------------------------------------------+-------------------------------------------+------------------------------------------------------+
    | :ref:`printobjtitle <printobjtitle>`        | :attr:`Tables.print_tables_as`            | | specifies whether only the titles                  |
    |                                             |                                           | | should be printed                                  | 
    +---------------------------------------------+-------------------------------------------+------------------------------------------------------+
    | :ref:`printobjlec <printobjlec>`            | :attr:`Equations.print_equations_lec_as`  | specifies the type of equation to print              |
    +---------------------------------------------+-------------------------------------------+------------------------------------------------------+
    | :ref:`printobjinfos <printobjinfos>`        | :attr:`Equations.print_equations_as`      | specifies the information to print                   |
    +---------------------------------------------+-------------------------------------------+------------------------------------------------------+

==============================
Table Compilation And Printing
==============================

    +---------------------------------------------+--------------------------------------------------+--------------------------------------------------+
    | Command                                     | Python                                           | Description                                      |
    +=============================================+==================================================+==================================================+
    | :ref:`PrintTblFile <printtblfile>`          | :meth:`Tables.print_to_file`                     | | defines files to use when printing             |
    |                                             |                                                  | | comparison tables                              |
    +---------------------------------------------+--------------------------------------------------+--------------------------------------------------+
    | :ref:`PrintTbl <printtbl>`                  | | :meth:`Table.compute` and                      | builds and prints tables in A2M format           |
    |                                             | | :meth:`ComputedTable.print_to_file`            |                                                  |
    +---------------------------------------------+--------------------------------------------------+--------------------------------------------------+
    | :ref:`ViewTblFile <viewtblfile>`            | :func:`load_extra_files`                         | | defines files to use when viewing              |
    |                                             |                                                  | | comparison tables                              |
    +---------------------------------------------+--------------------------------------------------+--------------------------------------------------+
    | :ref:`ViewTbl <viewtbl>`                    | :meth:`Table.compute`                            | builds and displays tables                       |
    +---------------------------------------------+--------------------------------------------------+--------------------------------------------------+
    | :ref:`ViewByTbl <viewbytbl>` = `ViewTbl`    | :meth:`Table.compute`                            | alias for ViewTbl                                |
    +---------------------------------------------+--------------------------------------------------+--------------------------------------------------+
    | :ref:`PrintVar <printvar>`                  | | :class:`Table` and                             | | builds and prints comparison tables            |
    |                                             | | :meth:`Table.compute`                          | | of series in A2M format                        |
    +---------------------------------------------+--------------------------------------------------+--------------------------------------------------+
    | :ref:`ViewVar <viewvar>`                    | | :class:`Table` and                             | | views comparison tables of series in           |
    |                                             | | :meth:`Table.compute`                          | | A2M format                                     |
    +---------------------------------------------+--------------------------------------------------+--------------------------------------------------+
    | :ref:`ViewNdec <viewndec>`                  | :meth:`Table.compute`                            | | specifies the number of decimals for           |
    |                                             |                                                  | | values displayed in tables                     |
    +---------------------------------------------+--------------------------------------------------+--------------------------------------------------+
    | :ref:`ViewWidth <viewwidth>` (obsolete)     | via GUI                                          | | specifies column width when displaying         |
    |                                             |                                                  | | tables                                         |
    +---------------------------------------------+--------------------------------------------------+--------------------------------------------------+
    | :ref:`ViewWidth0 <viewwidth0>` (obsolete)   | via GUI                                          | | specifies the width of the first column        |
    |                                             |                                                  | | when displaying tables                         |
    +---------------------------------------------+--------------------------------------------------+--------------------------------------------------+  

=======================
Graphs From IODE Tables
=======================

    +---------------------------------------------+--------------------------------------------------+--------------------------------------------------------------------------+
    | Command                                     | Python                                           | Description                                                              |
    +=============================================+==================================================+==========================================================================+
    | :ref:`ViewGr <viewgr>`                      | :meth:`ComputedTable.plot`                       | displays tables as graphs                                                |
    +---------------------------------------------+--------------------------------------------------+--------------------------------------------------------------------------+
    | :ref:`PrintGr <printgr>`                    | :meth:`ComputedTable.print_to_file`              | prints one or more graphs defined from tables                            |
    +---------------------------------------------+--------------------------------------------------+--------------------------------------------------------------------------+
    | :ref:`DataPrintGraph <dataprintgraph>`      | :meth:`ComputedTable.plot`                       | prints graphs built directly from variables                              |
    +---------------------------------------------+--------------------------------------------------+--------------------------------------------------------------------------+

====================
Models (Simulations)
====================

    +-----------------------------------------------------------+----------------------------------------+-------------------------------------+
    | Command                                                   | Python                                 | Description                         |
    +===========================================================+========================================+=====================================+
    | :ref:`ModelCalcSCC <modelcalcscc>`                        | :meth:`Simulation.model_calculate_SCC` | | decomposes the model into SCC     |
    |                                                           |                                        | | and reorders it                   |
    +-----------------------------------------------------------+----------------------------------------+-------------------------------------+
    | :ref:`ModelSimulateParms <modelsimulateparms>`            | :class:`Simulation`                    | prepares new simulation             |
    +-----------------------------------------------------------+----------------------------------------+-------------------------------------+
    | :ref:`ModelSimulate <modelsimulate>`                      | :meth:`Simulation.model_simulate`      | | launches the simulation           |
    |                                                           |                                        | | of a model                        |
    +-----------------------------------------------------------+----------------------------------------+-------------------------------------+
    | :ref:`ModelSimulateSCC <modelsimulatescc>`                | :meth:`Simulation.model_simulate_SCC`  | | launches simulation of a model    |
    |                                                           |                                        | | decomposed into SCC and sorted    |
    +-----------------------------------------------------------+----------------------------------------+-------------------------------------+
    | :ref:`ModelExchange <modelexchange>`                      | :meth:`Simulation.model_exchange`      | | defines or cancels                |
    |                                                           |                                        | | endogenous-exogenous exchanges    |
    |                                                           |                                        | | for simulation                    |
    +-----------------------------------------------------------+----------------------------------------+-------------------------------------+
    | :ref:`ModelCompile <modelcompile>`                        | :meth:`Simulation.model_compile`       | | recompiles equations              |
    |                                                           |                                        | | (useful if equations use macros)  |
    +-----------------------------------------------------------+----------------------------------------+-------------------------------------+
    | :ref:`ModelSimulateSaveNiters <modelsimulatesaveniters>`  | :meth:`Simulation.save_nb_iterations`  | | saves the number of iterations    |
    |                                                           |                                        | | required for each period          |
    |                                                           |                                        | | during simulation                 |
    +-----------------------------------------------------------+----------------------------------------+-------------------------------------+
    | :ref:`ModelSimulateSaveNorms <modelsimulatesavenorms>`    | :meth:`Simulation.save_norms`          | | saves the convergence threshold   |
    |                                                           |                                        | | reached for each period           |
    |                                                           |                                        | | during simulation                 |
    +-----------------------------------------------------------+----------------------------------------+-------------------------------------+

====================
Identities Execution
====================

    +------------------------------------------------+-------------------------------+-------------------------------------------------+
    | Command                                        | Python                        | Description                                     |
    +================================================+===============================+=================================================+
    | :ref:`idtexecute <idtexecute>`                 | :meth:`Identities.execute`    | executes identities and calculates series       |
    +------------------------------------------------+-------------------------------+-------------------------------------------------+
    | :ref:`idtexecutetrace <idtexecutetrace>`       | :meth:`Identities.execute`    | saves identity calculation trace in A2M file    |
    +------------------------------------------------+-------------------------------+-------------------------------------------------+
    | :ref:`idtexecutevarfiles <idtexecutevarfiles>` | :meth:`Identities.execute`    | | specifies files to search for variables       |
    |                                                |                               | | during identity calculation                   |
    +------------------------------------------------+-------------------------------+-------------------------------------------------+
    | :ref:`idtexecutesclfiles <idtexecutesclfiles>` | :meth:`Identities.execute`    | | specifies files to search for scalars         |
    |                                                |                               | | during identity calculation                   |
    +------------------------------------------------+-------------------------------+-------------------------------------------------+

====================
A2M File Translation
====================

    +---------------------------------------------+--------------------------------------------------+-------------------------------------------------+
    | Command                                     | Python                                           | Description                                     |
    +=============================================+==================================================+=================================================+
    | :ref:`A2mToHtml <a2mtohtml>`                |                                                  | translates A2M file to HTML format              |
    +---------------------------------------------+--------------------------------------------------+-------------------------------------------------+
    | :ref:`A2mToRtf <a2mtortf>`                  |                                                  | translates A2M file to RTF format               |
    +---------------------------------------------+--------------------------------------------------+-------------------------------------------------+
    | :ref:`A2mToMif <a2mtomif>`                  |                                                  | translates A2M file to MIF format (FrameMaker)  |
    +---------------------------------------------+--------------------------------------------------+-------------------------------------------------+
    | :ref:`A2mToCsv <a2mtocsv>`                  |                                                  | translates A2M file to CSV format               |
    +---------------------------------------------+--------------------------------------------------+-------------------------------------------------+
    | :ref:`A2mToPrinter <a2mtoprinter>`          |                                                  | interprets and prints an A2M file               |
    +---------------------------------------------+--------------------------------------------------+-------------------------------------------------+

=====================
Other Report Commands
=====================

    +---------------------------------------------+--------------------------------------------------+----------------------------------------------------------+
    | Command                                     | Python                                           | Description                                              |
    +=============================================+==================================================+==========================================================+
    | :ref:`StatUnitRoot <statunitroot>`          | :func:`dickey_fuller_test`                       | Dickey-Fuller tests                                      |
    +---------------------------------------------+--------------------------------------------------+----------------------------------------------------------+
    | :ref:`WsAggrChar <wsaggrchar>`              | To be implemented                                | | sets the character to introduce in the code of series  |
    |                                             |                                                  | | created by `WsAggr[...]`                               |
    +---------------------------------------------+--------------------------------------------------+----------------------------------------------------------+
    | :ref:`WsAggrSum <wsaggrsum>`                | To be implemented                                | computes the sum of series                               |
    +---------------------------------------------+--------------------------------------------------+----------------------------------------------------------+
    | :ref:`WsAggrMean <wsaggrmean>`              | To be implemented                                | computes the mean of series                              |
    +---------------------------------------------+--------------------------------------------------+----------------------------------------------------------+
    | :ref:`WsAggrProd <wsaggrprod>`              | To be implemented                                | computes the product of series                           |
    +---------------------------------------------+--------------------------------------------------+----------------------------------------------------------+