<commit_before>Installation
============

To install the romanesco worker on your system, we recommend using ``pip`` to
install the package. (If you wish to install from source, see the :ref:`install-from-source`
section of the developer documentation.) The following command will install the core dependencies: ::

    pip install romanesco

That will install the core romanesco library, but not the third-party dependencies for
any of its plugins. If you want to enable a set of plugins, their IDs should be included as
extras to the pip install command. For instance, if you are planning to use the R plugin
and the spark plugin, you would run: ::

    pip install romanesco[r,spark]

You can run this command at any time to install dependencies of other plugins, even if
romanesco is already installed.

.. _configuration:

Configuration
=============

Several aspects of Romanesco's behavior are controlled via its configuration file. This
file is found within the installed package directory as ``worker.local.cfg``. If this
file does not exist, simply run: ::

    cd romanesco ; cp worker.dist.cfg worker.local.cfg

The core configuration parameters are outlined below.

  * ``celery.app_main``: The name of the celery application. Clients will need to use
    this same name to identify what app to send tasks to. It is recommended to call this<commit_msg>Make Configuration one level down<commit_after>Installation
============

To install the romanesco worker on your system, we recommend using ``pip`` to
install the package. (If you wish to install from source, see the :ref:`install-from-source`
section of the developer documentation.) The following command will install the core dependencies: ::

    pip install romanesco

That will install the core romanesco library, but not the third-party dependencies for
any of its plugins. If you want to enable a set of plugins, their IDs should be included as
extras to the pip install command. For instance, if you are planning to use the R plugin
and the spark plugin, you would run: ::

    pip install romanesco[r,spark]

You can run this command at any time to install dependencies of other plugins, even if
romanesco is already installed.

.. _configuration:

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

Several aspects of Romanesco's behavior are controlled via its configuration file. This
file is found within the installed package directory as ``worker.local.cfg``. If this
file does not exist, simply run: ::

    cd romanesco ; cp worker.dist.cfg worker.local.cfg

The core configuration parameters are outlined below.

  * ``celery.app_main``: The name of the celery application. Clients will need to use
    this same name to identify what app to send tasks to. It is recommended to call this
{'fraction_non_alphanumeric': 0.06763636363636363, 'fraction_numerical': 0.0, 'mean_word_length': 4.25, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6052620', 'n_tokens_mistral': 680, 'n_tokens_neox': 656, 'n_words': 393}