README 3.73 KB
Newer Older
1 2 3 4 5
=====================
ARC MIDDLEWARE README
=====================
Last updated: 2019-01-16
`````````````````````````
6

7 8 9 10
Purpose of this Document
========================
This document is meant to introduce the reader to the
software and to point to existing documentation.
11

Florido Paganelli's avatar
Florido Paganelli committed
12

13 14
Table of contents
=================
15

16 17 18 19 20 21 22 23 24
  * What is the ARC Middleware
  * License
  * Getting the software
  * Installation
  * Configuration and Testing
  * Contributing
  * Support, Mailing lists
  * Documentation
  * Contact
25

Florido Paganelli's avatar
Florido Paganelli committed
26

27 28 29
What is the ARC Middleware
==========================
The Advanced Resource Connector (ARC) middleware, developed by the
30
NorduGrid Collaboration (<http://www.nordugrid.org>), is an open source software
31 32 33 34 35
solution enabling e-Science computing infrastructures with emphasis on
processing of large data volumes. 
ARC is being used to enable national and international e-infrastructures
since its first release in 2002.

Florido Paganelli's avatar
Florido Paganelli committed
36

37 38 39 40
License
=======
The software code is released under the Apache 2.0 License (see the
LICENSE file). 
Oxana Smirnova's avatar
Oxana Smirnova committed
41 42
The necessary 3rd party libraries are usually available in standard
Linux distributions; in rare cases NorduGrid repositories offer them.
43

Florido Paganelli's avatar
Florido Paganelli committed
44

45 46 47
Getting the software
====================
All the information about how to get the software is available at
48

49
  <http://download.nordugrid.org/>
50

Florido Paganelli's avatar
Florido Paganelli committed
51

52 53 54 55
Installation
============
If you want to install for a specific distribution, see the list of 
supported distributions here:
56

57 58 59
  <http://download.nordugrid.org/repos.html>
  
And follow the instructions here:
60

61
  <http://www.nordugrid.org/documents/arc6/user/index.html>
62

63
If you want to build and install the software yourself, please read
64

65
  <TBD>
66

Florido Paganelli's avatar
Florido Paganelli committed
67

68 69 70
Configuration and Testing
=========================
See the official online documentation:
71

72
  <http://www.nordugrid.org/documents/arc6/user/arc6_install_guide.html>
73

Florido Paganelli's avatar
Florido Paganelli committed
74

75 76 77
Contributing
============
The open source development of the ARC middleware is coordinated by
78 79 80
the NorduGrid Collaboration which is always open to new members.
Contributions from the community to the software and the documentation
is welcomed. Sources can be downloaded from the software repository
81 82
at <http://download.nordugrid.org> or the Coderefinery gitlab repository
at <https://https://source.coderefinery.org/nordugrid/arc>
83

84 85
The Technical Coordination Group (TCG) defines outstanding issues that 
have to be addressed in the framework of ARC development. Feature
86
requests and enhancement proposals are recorded in the Bugzilla bug
87
tracking system at <https://bugzilla.nordugrid.org>. For a more detailed
88
description, write access to the code repository and further
89 90
questions, subscribe and write to the *nordugrid-discuss* mailing list:
  <https://mail.nordugrid.org/mailman/listinfo>
91

92 93 94
Ongoing and completed e-Science research projects and student 
assignments related to the middleware are listed
on the NorduGrid web site: <http://www.nordugrid.org>
95

96

97
Support, Mailing lists
98
==============================================
99 100 101 102 103 104 105 106 107
User support and site installation assistance is provided via 
several mailing lists, among which the nordugrid-discuss mailing list 
is a general forum for all kind of issues related to the ARC middleware. 
  <https://mail.nordugrid.org/mailman/listinfo>

The Bugzilla problem tracking system accepts requests for features or 
enhancements, and is the prime medium to track and report problems.
  <https://bugzilla.nordugrid.org> 

Florido Paganelli's avatar
Florido Paganelli committed
108

109 110
Documentation
=============
111 112 113
Research papers, overview talks, reference manuals, user guides,
installation instructions, conference presentations, FAQ and even
tutorial materials can be fetched from the documentation section of
114 115 116 117 118
  <http://www.nordugrid.org>

ARC6 specific documentation is at
  <http://www.nordugrid.org/documents/arc6/>

Florido Paganelli's avatar
Florido Paganelli committed
119

120 121 122 123
Contact
=======
Contact information is kept updated on the <http://www.nordugrid.org>
web site.