Updated README.md

  only:

    - master

  script:

   - cp -R build public

   - cp -R docker/build public

   - mv build/htmlcov/* public

  artifacts:

    paths:

    * [Running tests](#running-tests) 

* [CSP_Low LMC](#csp-low-lmc)

    * [Run in containers](#how-to-run-in-docker-containers)

* 

* [Known bugs](#known-bugs)

* [Troubleshooting](#troubleshooting)

* [License](#license)

## Introduction

General requirements for the monitor and control functionality are the same for both the SKA MID and LOW telescopes. <br/>

In addition, two of three other CSP Sub-elements, namely the `Pulsar Search` and the `Pulsar Timing`, have the same functionality

and use the same design in both telescopes.<br/>

In addition, two of three other CSP Sub-elements, namely the `Pulsar Search` and the `Pulsar Timing`, have the same functionality and use the same design in both telescopes.<br/>

Functionality common to `CSP_Low.LMC` and `CSP_Mid.LMC` includes: communication framework, logging, archiving, alarm generation, sub-

arraying, some of the functionality related to handling observing mode changes, `Pulsar Search` and

`Pulsar Timing`, and to some extent Very Long Baseline Interferometry (`VLBI`).<br/>

* `mid-csp-lmc.yml`

* `mid-cbf-mcs.yml`

Each file includes the stages to run the the `CSP_Mid.LMC TANGO DB`, the `CSP_Mid.LMC` devices and `Mid-CBF.LMC` TANGO Devices inside 

separate docker containers.<br/>

Each file includes the stages to run the the `CSP_Mid.LMC TANGO DB`, the `CSP_Mid.LMC` devices and `Mid-CBF.LMC` TANGO Devices inside separate docker containers.<br/>

These YAML files are used by `docker-compose` to run both the CSP_Mid.LMC and CBF.LMC TANGO device

instances, that is, to run the whole `CSP_Mid.LMC` prototype.>br\>

In this way, it's possible to execute some preliminary integration tests, as for example the assignment/release of receptors to a `CSP_Mid Subarray` and its configuration to execute a scan in Imaging mode.

In this way, it's possible to execute some preliminary integration tests, as for example the assignment/release of receptors to a `CSP_Mid Subarray` and its configuration to execute a scan in Imaging mode.<br/>

The `CSP_Mid.LMC` and `Mid-CBF.LMC TANGO` Devices are registered with the same TANGO DB, and its 

configuration is performed via the `dsconfig` TANGO Device provided by the [dsconfig project](https://gitlab.com/MaxIV-KitsControls/lib-maxiv-dsconfig). <br />

This device use a JSON file to configure the TANGO DB. <br/>

The `CSP_Mid.LMC` and `Mid-CBF.LMC` projects provide its own  JSON file:

[midcsplmc\_dsconfig.json](csp-lmc/csp-lmc-mid/csp-lmc-mid/docker/config/midcsplmc_dsconfig.json) and [midcbf\_dsconfig.json](sp-lmc/csp-lmc-mid/csp-lmc-mid/docker/config/midcbf_dsconfig.json)  

To run the `CSP_Mid.LMC` prototype inside Docker containers, 

issue the command:

To run the `CSP_Mid.LMC` prototype inside Docker containers,issue the command:

```bash

make up

                                simulator provided by the CBF project to support scan

                                configuration for Subarray1/2

```

To stop and removes the Docker containers, issue the command

<pre><code>make down</code></pre>

from the prototype root directory.

Running `jive` on the local host, the `CSP.LMC` and `Mid-CBF.LMC` TANGO Devices registered with the TANGO DB (running in a docker container)

can be visualized and explored.

## Running tests

The project includes a set of tests for the `MidCspMaster` and `MidCspSubarray` TANGO Devices that can be found in the project `tests` folder.<br/>

## Known bugs

*

## Troubleshooting

[MASTER]

# Specify a configuration file.

#rcfile=

# Python code to execute, usually for sys.path manipulation such as

# pygtk.require().

#init-hook='

# Profiled execution.

profile=no

# Add files or directories to the blacklist. They should be base names, not

# paths.

ignore=CVS

# Pickle collected data for later comparisons.

persistent=yes

# List of plugins (as comma separated values of python modules names) to load,

# usually to register additional checkers.

load-plugins=pylint_junit

[MESSAGES CONTROL]

# Enable the message, report, category or checker with the given id(s). You can

# either give multiple identifier separated by comma (,) or put this option

# multiple time. See also the "--disable" option for examples.

enable=unreachable,

       duplicate-key,

       unnecessary-semicolon,

       global-variable-not-assigned,

       unused-variable,

       binary-op-exception,

       bad-format-string,

       anomalous-backslash-in-string,

       bad-open-mode

# Disable the message, report, category or checker with the given id(s). You

# can either give multiple identifiers separated by comma (,) or put this

# option multiple times (only on the command line, not in the configuration

# file where it should appear only once).You can also use "--disable=all" to

# disable everything first and then reenable specific checks. For example, if

# you want to run only the similarities checker, you can use "--disable=all

# --enable=similarities". If you want to run only the classes checker, but have

# no Warning level messages displayed, use"--disable=all --enable=classes

# --disable=W"

disable= R,C,W,

        no-member,

[REPORTS]

# Set the output format. Available formats are text, parseable, colorized, msvs

# (visual studio) and html. You can also give a reporter class, eg

# mypackage.mymodule.MyReporterClass.

#output-format=parseable

output-format=junit

# Put messages in a separate file for each module / package specified on the

# command line instead of printing them on stdout. Reports (if any) will be

# written in a file name "pylint_global.[txt|html]".

files-output=no

# Tells whether to display a full report or only the messages

reports=yes

# Activate the evaluation score.

score=yes

# Python expression which should return a note less than 10 (10 is the highest

# note). You have access to the variables errors warning, statement which

# respectively contain the number of errors / warnings messages and the total

# number of statements analyzed. This is used by the global evaluation report

# (RP0004).

evaluation= 10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)

# Add a comment according to your evaluation note. This is used by the global

# evaluation report (RP0004).

comment=no

# Template used to display messages. This is a python new-style format string

# used to format the message information. See doc for all details

#msg-template=

[SIMILARITIES]

# Minimum lines number of a similarity.

min-similarity-lines=4

# Ignore comments when computing similarities.

ignore-comments=yes

# Ignore docstrings when computing similarities.

ignore-docstrings=yes

# Ignore imports when computing similarities.

ignore-imports=no

[TYPECHECK]

# Tells whether missing members accessed in mixin class should be ignored. A

# mixin class is detected if its name ends with "mixin" (case insensitive).

ignore-mixin-members=yes

# List of classes names for which member attributes should not be checked

# (useful for classes with attributes dynamically set).

ignored-classes=SQLObject

# Show a hint with possible names when a member name was not found. The aspect

# of finding the hint is based on edit distance.

missing-member-hint=yes

# When zope mode is activated, add a predefined set of Zope acquired attributes

# to generated-members.

zope=no

# List of members which are set dynamically and missed by pylint inference

# system, and so shouldn't trigger E0201 when accessed. Python regular

# expressions are accepted.

generated-members=REQUEST,acl_users,aq_parent

[VARIABLES]

# Tells whether we should check for unused import in __init__ files.

init-import=no

# A regular expression matching the beginning of the name of dummy variables

# (i.e. not used).

dummy-variables-rgx=_$|dummy

# List of additional names supposed to be defined in builtins. Remember that

# you should avoid to define new builtins when possible.

additional-builtins=

# Tells whether unused global variables should be treated as a violation.

allow-global-unused-variables=yes

[FORMAT]

# Maximum number of characters on a single line.

max-line-length=100

# Regexp for a line that is allowed to be longer than the limit.

ignore-long-lines=^\s*(# )?<?https?://\S+>?$

# Allow the body of an if to be on the same line as the test if there is no

# else.

single-line-if-stmt=no

# List of optional constructs for which whitespace checking is disabled

no-space-check=trailing-comma,dict-separator

# Maximum number of lines in a module

max-module-lines=1000

# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1

# tab).

indent-string='    '

[BASIC]

# Required attributes for module, separated by a comma

required-attributes=

# List of builtins function names that should not be used, separated by a comma

bad-functions=map,filter,apply,input

# Regular expression which should only match correct module names

module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$

# Regular expression which should only match correct module level names

const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$

# Regular expression which should only match correct class names

class-rgx=[A-Z_][a-zA-Z0-9]+$

# Regular expression which should only match correct function names

function-rgx=[a-z_][a-z0-9_]{2,30}$

# Regular expression which should only match correct method names

method-rgx=[a-z_][a-z0-9_]{2,30}$

# Regular expression which should only match correct instance attribute names

attr-rgx=[a-z_][a-z0-9_]{2,30}$

# Regular expression which should only match correct argument names

argument-rgx=[a-z_][a-z0-9_]{2,30}$

# Regular expression which should only match correct variable names

variable-rgx=[a-z_][a-z0-9_]{2,30}$

# Regular expression which should only match correct attribute names in class

# bodies

class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$

# Regular expression which should only match correct list comprehension /

# generator expression variable names

inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$

# Good variable names which should always be accepted, separated by a comma

good-names=i,j,k,ex,Run,_

# Bad variable names which should always be refused, separated by a comma

bad-names=foo,bar,baz,toto,tutu,tata

# Regular expression which should only match function or class names that do

# not require a docstring.

no-docstring-rgx=__.*__

# Minimum line length for functions/classes that require docstrings, shorter

# ones are exempt.

docstring-min-length=-1

[MISCELLANEOUS]

# List of note tags to take in consideration, separated by a comma.

notes=FIXME,

      XXX,

      TODO

[IMPORTS]

# Deprecated modules which should not be used, separated by a comma

deprecated-modules=regsub,TERMIOS,Bastion,rexec

# Create a graph of every (i.e. internal and external) dependencies in the

# given file (report RP0402 must not be disabled)

import-graph=

# Create a graph of external dependencies in the given file (report RP0402 must

# not be disabled)

ext-import-graph=

# Create a graph of internal dependencies in the given file (report RP0402 must

# not be disabled)

int-import-graph=

[CLASSES]

# List of interface methods to ignore, separated by a comma. This is used for

# instance to not check methods defines in Zope's Interface base class.

ignore-iface-methods=isImplementedBy,deferred,extends,names,namesAndDescriptions,queryDescriptionFor,getBases,getDescriptionFor,getDoc,getName,getTaggedValue,getTaggedValueTags,isEqualOrExtendedBy,setTaggedValue,isImplementedByInstancesOf,adaptWith,is_implemented_by

# List of method names used to declare (i.e. assign) instance attributes.

defining-attr-methods=__init__,__new__,setUp

# List of valid names for the first argument in a class method.

valid-classmethod-first-arg=cls

# List of valid names for the first argument in a metaclass class method.

valid-metaclass-classmethod-first-arg=mcs

[DESIGN]

# Maximum number of arguments for function / method

max-args=5

# Argument names that match this expression will be ignored. Default to name

# with leading underscore

ignored-argument-names=_.*

# Maximum number of locals for function / method body

max-locals=20

# Maximum number of return / yield for function / method body

max-returns=6

# Maximum number of branch for function / method body

max-branches=15

# Maximum number of statements in function / method body

max-statements=50

# Maximum number of parents for a class (see R0901).

max-parents=7

# Maximum number of attributes for a class (see R0902).

max-attributes=20

# Minimum number of public methods for a class (see R0903).

min-public-methods=2

# Maximum number of public methods for a class (see R0904).

max-public-methods=40

[EXCEPTIONS]

# Exceptions that will emit a warning when being caught. Defaults to

# "Exception"

overgeneral-exceptions=Exception

MarkupSafe = "*"

Pygments = "*"

pylint = "*"

pylint-junit = "*"

pytest = "*"

pytest-cov = "*"

pytest-pylint = "*"