..
      Copyright European Organization for Nuclear Research (CERN)

      Licensed under the Apache License, Version 2.0 (the "License");
      You may not use this file except in compliance with the License.
      You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0


Welcome to Rucio's documentation!
=================================

The Rucio project is the new version of ATLAS Distributed Data Management (DDM) system services
for allowing the ATLAS collaboration to manage the large volumes of data, both taken by the
detector as well as generated or derived, in the ATLAS distributed computing system.
Rucio uses to manage accounts, files, datasets and distibuted storage systems.

This documentation is generated by the  `Sphinx toolkit`_. and lives in the source tree.

.. _`Sphinx toolkit`: http://sphinx.pocoo.org/

Links:
 * Documentation - http://rucio.cern.ch
 * Project tracker - https://its.cern.ch/jira/browse/RUCIO
 * Code analytics and search services - https://www.ohloh.net/p/rucio/


Concepts and terminology
========================

The following concepts define how data is organised, accessed, and catalogued by Rucio.

.. toctree::
    :maxdepth: 1

    overview_Rucio_account
    overview_File_Dataset_Container
    overview_Meta-data_attributes
    overview_Rucio_Storage_Element
    overview_Permission_model
    overview_Replica_management
    replication_rules_examples
    overview_Accounting_and_quota
    overview_Notifications
    overview_Subscriptions

Architecture
============

.. toctree::
    :maxdepth: 1

    overview_Architecture
    overview_Rucio_Storage_Element_Manager
    overview_Scheduled_Transfers
    overview_Data_Deletion
    overview_Database_Schema
    overview_Rules
    rules_workflow
    overview_Exception_Handling
    usecases
    overview_flow

Developer Documentation
=======================

.. toctree::
    :maxdepth: 1

    development_guidelines
    setup
    developing
    naming_convention_db

Installing Rucio
================

.. toctree::
    :maxdepth: 1

    installing_clients
    installing_atlas_clients
    installing_server
    overview_Deployment
    atlas_integration_testbed

Rucio RESTful API
=================

.. toctree::
    :maxdepth: 1

    rest
    api_curl_examples
    REST_Intro


Rucio Python Client APIs
========================

.. toctree::
    :maxdepth: 1

    rucio_clients
    client_examples
    account
    accountlimit
    scope
    identity
    did
    meta-data
    rse
    replica
    rule
    lock
    subscription
    core_constants
    exception

Rucio CLI
=========

.. toctree::
    :maxdepth: 1

    rucio_cli
    cli_examples
    cli_admin_examples
    client_tutorial
    client_howto

Appendices
==========

.. toctree::
    :maxdepth: 1

    Acronyms_and_Abbreviations

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

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