.. _fake_data_agent:

===============
Fake Data Agent
===============

The Fake Data Agent is provided with OCS to help demonstrate and debug issues
with data aggregation and display. It will generate random data and pass it to
an OCS feed.

.. argparse::
   :module: ocs.agents.fake_data.agent
   :func: add_agent_args
   :prog: agent.py

Configuration File Examples
---------------------------

Below are configuration examples for the ocs config file and for running the
Agent in a docker container.

OCS Site Config
```````````````

To configure the Fake Data Agent we need to add a FakeDataAgent block to our
ocs configuration file. Here is an example configuration block using all of the
available arguments::

    {'agent-class': 'FakeDataAgent',
     'instance-id': 'fake-data1',
     'arguments': ['--mode', 'acq',
                   '--num-channels', '16',
                   '--sample-rate', '4']},

Docker Compose
``````````````

The Fake Data Agent can also be run in a Docker container. An example
docker compose service configuration is shown here::

    fake-data1:
        image: simonsobs/ocs:latest
        hostname: ocs-docker
        environment:
          - LOGLEVEL=info
          - INSTANCE_ID=fake-data1
        volumes:
          - ${OCS_CONFIG_DIR}:/config:ro

Agent API
---------

.. autoclass:: ocs.agents.fake_data.agent.FakeDataAgent
    :members: