.. _screener_example:

Screener Example
================

Generally, an asset screener filters a universe of assets to identify those that meet some criteria/s.
In boatwright, the :ref:`boatwright.Screener <Screener>` filters an asset universe using one or more :ref:`boatwright.Strategy <Strategy>` instances and counts how many orders have been generated in a recent period.
For convenience, users can save asset universes in CSV files, and define a collection of strategies, including variable parameter settings, in a JSON file. 
In addition to writing a python program, the screener can be run from the command line interface as:

.. code-block:: bash

    boatwright screen -sf strategies.json -uv universe.csv -tp 3 -dg "DAY"

.. image:: images/screener/screener_table.png
    :align: center

**Strategies JSON file:** :download:`../../examples/screener_example/strategies.json`

.. literalinclude:: ../../examples/screener_example/strategies.json