.. _popy_tools:

Command Line Tools
##################

The |popy| tools and their functions are summarised in :numref:`table_tools`:-

.. _table_tools:

.. list-table:: |popy| Command Line Tools
    :header-rows: 1
    
    * - Name
      - Example
      - Function
      
    * - :ref:`popy_env`
      - popy_env
      - invoke the |popy| environment

    * - :ref:`popy_run`
      - popy_run my_script.pyml
      - run a |popy| script

    * - :ref:`popy_check`
      - popy_check my_script.pyml
      - check a |popy| script
    
    * - :ref:`popy_create`
      - popy_create fit my_script.pyml
      - create an example |popy| script
      
    * - :ref:`popy_format`
      - popy_format my_script.pyml
      - update |popy| script format
      
    * - :ref:`popy_edit`
      - popy_edit my_script.pyml
      - open |popy| script in editor
      
    * - :ref:`popy_doc`
      - popy_doc
      - open |popy| documentation in browser
     
    * - :ref:`popy_view`
      - popy_view my_script.pyml.html
      - open |popy| html output in browser
      
    * - :ref:`popy_info`
      - popy_info
      - display |popy| install details
     
    * - :ref:`popy_validate`
      - popy_validate
      - run :ref:`validation <validate_popy>` 
     
    * - :ref:`popy_activate`
      - popy_activate XXXX
      - :ref:`activate_popy` using a |prod_key|
     
    * - :ref:`popy_deactivate`
      - popy_deactivate
      - :ref:`deactivate_popy` a |prod_key|
     
    * - :ref:`popy_imconv`
      - popy_imconv \*.svg png
      - convert images using :ref:`inkscape`
     
.. toctree::
   :maxdepth: 1
   :hidden:
   
   popy_env
   popy_run      
   popy_check
   popy_create
   popy_format
   popy_edit
   popy_doc  
   popy_view
   popy_info
   popy_validate
   popy_activate
   popy_deactivate
   popy_imconv
   

