README.md 2.19 KB
Newer Older
Beatriz Sanchez's avatar
Beatriz Sanchez committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
# EUDAT B2SAFE

#### Table of Contents

1. [B2SAFE Description - Why B2SAFE](#module-description)
2. [PREREQUISITES - How to install IRODS and B2HANDLE](#prerequisites)
3. [Install - How to install the B2SAFE](#install)
4. [B2SHARE - How to connect B2SHARE with  B2SAFE](#b2share)
4. [Development - Guide for contributing to B2SAFE](#development)
5. [Testing - Instructions to test the code](#testing)


## Module Description

This repository provides the **B2SAFE** service code from the EUDAT project.
ccacciari's avatar
ccacciari committed
16
17

It is released under BSD license.
18

Beatriz Sanchez's avatar
Beatriz Sanchez committed
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
The [EUDAT](http://www.eudat.eu) B2SAFE Service offers functionality to replicate datasets across different data centres in a safe and efficient way while maintaining all information required to easily find and query information about the replica locations. The information about the replica locations and other important information is stored in PID (Persistent IDentifier) records, each managed in separate administrative domains. 
The **B2SAFE** Service is implemented as an [iRODS](http://www.irods.org) module providing a set of iRODS rules or policies to interface with the [EPIC](http://www.pidconsortium.eu) handle API and uses the iRODS middleware to replicate datasets from a source data (or community) centre to a destination data centre.

The documetation can be found in the [B2SAFE-wiki](https://gitlab.eudat.ei/b2safe/B2SAFE-core/-/wikis)

Known issues can be found in [https://github.com/EUDAT-B2SAFE/B2SAFE-core/wiki/Known-issues](https://github.com/EUDAT-B2SAFE/B2SAFE-core/wiki/Known-issues)

## Install

1. on your **SAFE** server go to the irods user home directory
2. git clone this repository
```
git clone .git B2SAFE-core
```

## b2share

To install the B2SHARE connectors you need to use pipenv (install using pip3 install  pipenv)cat 

```
pipenv --python 2 install -r requirements.txt
```

Run unit tests

```
pipenv --python 2 shell
py.test  ../scripts/tests/testB2shareConnectionClient
```

Run connectors

```
pipenv --python 2 shell
python b2shareclientCLI.py ...
```



 
59

ccacciari's avatar
ccacciari committed
60
61
62
63
---------------
Deployment
---------------

Beatriz Sanchez's avatar
Beatriz Sanchez committed
64
65
66
67
* [Deployment on Centos 7, see install_centos7.md](install_centos7.md)
* [Deployment on other systems, see install_other.txt](install_other.txt)


68