Technical support
+++++++++++++++++

..  First two lines are removed by deploy scripts.
.. header:: Turberfield technical support

..  Titling
    ##++::==~~--''``

.. title:: Turberfield technical support

Installation
::::::::::::

I recommend you run Turberfield on `Ubuntu 14.04 LTS`_. This is a `GNU/Linux`
system. If you've never used Linux before, your first job is to install it and
play with it until you are able successfully to run the following command::

    $ espeak -v cy+f5 'eargain'

Turberfield is written in the Python_ programming language. You need to know
how to create a Python `virtual environment`_ for version 3.4 of Python.
Then install ``turberfield-eargain`` using the ``pip`` command in your
`venv`::

    $ <path_to_venv>/local/bin/pip install turberfield-eargain

To check it all works, try running the tests like this::

    $ <path_to_venv>/bin/python -m unittest discover turberfield

Getting started
:::::::::::::::

Although Turberfield is a complex piece of work, when you run it from
the command line it gives a simple and useful output::

    $ <path_to_venv>/bin/python -m turberfield.eargain.main

::

    {}
        header:version: 0.005
    {}
        ledger:columns:    [
                [honour, SILV, asset],
                [reserves, SILV, asset],
                [loans, SILV, asset],
                [vault, SILV, liability],
                [firms, SILV, liability],
                [workers, SILV, liability],
                [currency, SILV, liability],
                [chest, SILV, income],
                [nuts, NUTS, capital],
                [NUTS trading account, NUTS, trading],
                [SILV trading account, SILV, trading]
            ]
        ledger:ref: SILV

    {}
        <class 'turberfield.common.inventory.Character'>:
            12
        <class 'turberfield.common.inventory.Location'>:
            5
        <class 'turberfield.common.inventory.Resource'>:
            10
        <enum 'Commodity'>:
            20
        <enum 'DecimalCoin'>:
            10
        <enum 'Scrip'>:
            2
        note:
            End of simulated interval
        ts:
            86400
    [ 1000.00, 99.60, 0.00, 1000.00, 0.00, 0.00, 1.00, 0.00, 98.60, 0.00, 0.00]

    {}
        <class 'turberfield.common.inventory.Character'>:
            16
        <class 'turberfield.common.inventory.Location'>:
            5
        <class 'turberfield.common.inventory.Resource'>:
            313
        <enum 'Commodity'>:
            28
        <enum 'DecimalCoin'>:
            10
        <enum 'Scrip'>:
            2
        note:
            End of simulated interval
        ts:
            2505600
    [ 1000.00, 99.60, 0.00, 1000.00, 0.00, 0.00, 1.00, 0.00, 98.60, 0.00, 0.00]

    .
    .
    .

    {}
        <class 'turberfield.common.inventory.Character'>:
            78
        <class 'turberfield.common.inventory.Location'>:
            8
        <class 'turberfield.common.inventory.Resource'>:
            30341
        <enum 'Commodity'>:
            152
        <enum 'DecimalCoin'>:
            10
        <enum 'Scrip'>:
            2
        note:
            End of simulated interval
        ts:
            60566400
    [ 790.00, 99.60, 210.00, 790.00, 210.00, 0.00, 1.00, 0.00, 98.60, 0.00, 0.00]

Plotting the output
===================

..  note::

    **TODO**

Site support
::::::::::::

Eargain launched in Spring 2014, and I am working on it nearly every day.
I test changes as well as I can, but if something goes wrong I hope you
will be ready to bring it to my attention.

It will help if you quote to me the `build details`_ you see below.
They may have changed by the time I get your message.

Of course, I'd also be interested to hear your general comments about
the site, your stories about how it helps you, and your ideas for new
features.

You can contact me here:

webmaster@thuswise.co.uk

Build details
:::::::::::::

Where available, the table below shows the versions of Turberfield
packages.

========    ==============  ===============
Package     Rev             LLOC
========    ==============  ===============
Common      |common_rev|    |common_lloc|
Dynamics    |dynamics_rev|  |dynamics_lloc|
Eargain     |eargain_rev|   |eargain_lloc|
========    ==============  ===============

.. _Ubuntu 14.04 LTS: http://ubuntu.com
.. _Python: http://python.org
.. _virtual environment: https://docs.python.org/3/library/venv.html
 
.. footer:: Copyright 2014 Thuswise Ltd

..  These lines are modified by the deploy scripts.

.. |common_rev| replace:: ?
.. |common_lloc| replace:: ?
.. |dynamics_rev| replace:: ?
.. |dynamics_lloc| replace:: ?
.. |eargain_rev| replace:: ?
.. |eargain_lloc| replace:: ?