Skip to content

Latest commit

 

History

History
118 lines (75 loc) · 5.36 KB

README.rst

File metadata and controls

118 lines (75 loc) · 5.36 KB

Cite us:

Status master branch (stable):

Basic Tests Status Dirac Install Status Pilot Wrapper Status Integration Tests Status Documentation Status

Status integration branch (devel):

Basic Tests Status Dirac Install Status Pilot Wrapper Status Integration Tests Status Documentation Status

DIRAC

DIRAC is an interware, meaning a software framework for distributed computing.

DIRAC provides a complete solution to one or more user community requiring access to distributed resources. DIRAC builds a layer between the users and the resources offering a common interface to a number of heterogeneous providers, integrating them in a seamless manner, providing interoperability, at the same time as an optimized, transparent and reliable usage of the resources.

DIRAC has been started by the LHCb collaboration who still maintains it. It is now used by several communities (AKA VO=Virtual Organizations) for their distributed computing workflows.

DIRAC is written in python 2.7.13 and transitioning to python 3.

Important links

Install

There are basically 2 types of installations: client, and server.

For DIRAC client installation instructions, see the web page.

For DIRAC server installation instructions, see the web page.

The supported distributions are EL6 (e.g. SLC6) and EL7 (e.g. CC7).

Development

Contributing

DIRAC is a fully open source project, and you are welcome to contribute to it. A list of its main authors can be found here A detailed explanation on how to contribute to DIRAC can be found in this page. For a quick'n dirty guide on how to contribute, simply:

  • fork the project
  • work on a branch
  • create a Pull Request, target the "integration" branch.

Code quality

The contributions are subject to reviews.

Pylint, and pep8 style checker are run regularly on the source code. The .pylintrc file defines the expected coding rules and peculiarities (e.g.: tabs consists of 2 spaces instead of 4). Each Pull Request is checked for pylint and pep8 compliance.

Each PR is a also subject to check for python 3 compatibility. If you are issuing PRs that are devoted to future versions of DIRAC (so, not for patch releases), for each of the python files touched please run (and react to):

pylint --rcfile=tests/.pylintrc3k --py3k --msg-template="{path}:{line}: [{msg_id}({symbol}), {obj}] {msg}" --extension-pkg-whitelist=GSI,numpy path/to/file.py

Testing

Unit tests are provided within the source code. Integration, regression and system tests are instead in the DIRAC/tests/ directory. Run pytest to run all unit tests (it will include the coverage).