.. _popy_check:

popy_check
##########

When developing a |popy| script file it is sometimes useful to sanity check the input and automatically detect common errors. 

Note this checking process also happens when using :ref:`popy_run`, however the :command:`popy_check` enables you to check before you are ready to run a script.

Check a script by opening a :ref:`open_a_popy_command_prompt` and typing:-

.. code-block:: console

    $ popy_check my_script.pyml
 
this will output the results of the check to the terminal and also to a log file called:-

.. code-block:: console

    my_script.pyml.check.log
 
Hopefully the various error and warning messages will enable you to more easily edit and fix a broken script file.

Command line options
--------------------

.. literalinclude:: /_autogen/tool_help/popy_check_help.inc
    :language: console 
