.. _Configuration:

Configuration
-------------

.. _env_var:


Environment Variables
^^^^^^^^^^^^^^^^^^^^^

Some default settings of ``orto`` can be configured using the environment variables listed in Table 1.

Note, these options only apply when ``orto`` is used through its command line interface (CLI),
and in the case of custom fonts, users must have the specified font installed on their system.

Additionally, changing some of the environment variables used for plotting may lead
to **unsupported** and unexpected behaviour - you have been warned!

+-------------------------+---------------------------------------------------------+
| Variable Name           | Description                                             |
+=========================+=========================================================+
| ``orto_orca_load``      | Module load command for orca                            |
+-------------------------+---------------------------------------------------------+
| ``orto_termcolor``      | If set (to any value) enables colour-coded output in    |
|                         |                                                         |
|                         | windows terminal                                        |
+-------------------------+---------------------------------------------------------+

The process for setting these variables depends on your platform

Mac and Linux users:

.. code-block:: bash

    export variablename=VALUE

For example:

.. code-block:: bash
    
    export pnmr_plotformat=.png


Windows CMD (Command Prompt) users can set variables temporarily using

.. code-block:: doscon

    set variablename=

while Windows Powershell (PS) users can use

.. code-block:: doscon

    $env:variablename=

these will persist only for the current window. To set Windows environment variables permanently, use the system environment variable window.

Terminal output
^^^^^^^^^^^^^^^

Mac and Linux users will see a colour-coded terminal output. By default this is disabled for Windows users since ``CMD`` does
not support ASCII colour codes. If you are on Windows and are using an ASCII enabled terminal (e.g. Windows Terminal) you can
enable colour-coded output by setting the ``orto_termcolor`` environment variable to any value in the system environment variable window.