.. BelleDIRAC_doc documentation master file, created by
   sphinx-quickstart on Sat Jan  8 20:17:28 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to the BelleDIRAC development documentation!
================================================

Belle II, with its high data flow and global collaboration, uses a Distributed Computing model, aka `"grid computing" <https://en.wikipedia.org/wiki/Grid_computing>`__. Before starting a development task, you should get familiar with the `data model and computing <https://software.belle2.org/sphinx/recommended-training/online_book/computing.html>`__  for Belle II.

BelleDIRAC is an experiment specific extention of `DIRAC <https://dirac.readthedocs.io/en/latest/index.html>`__, which is an interware that acts as a layer between a community/users and the grid. You can refer to `DIRAC Systems <https://dirac.readthedocs.io/en/latest/AdministratorGuide/Systems/index.html>`__ to learn more about the system provided by DIRAC. BelleDIRAC does not use all of these and some of the distributed computing tools, like the Production System, are custom built to cover our experiment-specific needs.

We also use other resources within BelleDIRAC:

1. `Rucio <https://rucio.cern.ch/documentation/>`__  is used as a Distrubted Data Management (DDM) System and as a File Catalog.
2. ARDA Metadata Grid Application, aka AMGA, is used as a Metadata Catalog.

Having some familarity with the following will also help you get started with development tasks:

1. Git is a software versioning system used extensively at Belle II. You can check out the official `tutorial <https://git-scm.com/docs/gittutorial>`__ and some helpful details about `stash <https://confluence.desy.de/pages/viewpage.action?pageId=35819226>`__, the website that hosts the Git repositories for Belle II.
2. The object oriented programing philosophy is used at Belle II. You can find some helpful information on the `Python tutorial <https://realpython.com/python3-object-oriented-programming/>`__.
3. Before starting on a development task, you should consider using an integrated development environment like `VS code <https://code.visualstudio.com/>`__ or `pychram <https://code.visualstudio.com/>`__.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   ClientDevelopment
   CodingConvention
   ArchitectureOverview
   CreateGb2Tools
   OpsInfo


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`