README.md 1017 Bytes
Newer Older
Lauri Himanen's avatar
Lauri Himanen committed
1
# __python-common__
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18

This repository contains the common python files that are
part of the [NOMAD Laboratory](http://nomad-lab.eu).
The official version lives at

    git@gitlab.mpcdf.mpg.de:nomad-lab/python-common.git

you can browse it at

    https://gitlab.mpcdf.mpg.de/nomad-lab/python-common

Some things rely on having the nomad-meta-info checked out at the same level.
The simplest way to have this is to check out nomad-lab-base recursively:

    git clone --recursive git@gitlab.mpcdf.mpg.de:nomad-lab/nomad-lab-base.git

then this will be in python-common within it.
Lauri Himanen's avatar
Lauri Himanen committed
19

Lauri Himanen's avatar
Lauri Himanen committed
20 21 22
# Installation
The code is python>=2.7 and python>=3.4 compatible. First download and install
this package:
23 24

```sh
Lauri Himanen's avatar
Lauri Himanen committed
25 26 27 28
git clone https://gitlab.mpcdf.mpg.de/nomad-lab/python-common.git
cd python-common
pip install -r requirements.txt
pip install -e .
29 30
```

Lauri Himanen's avatar
Lauri Himanen committed
31 32
Then download the metainfo definitions to the same folder where the
'python-common' repository was cloned:
Lauri Himanen's avatar
Lauri Himanen committed
33 34

```sh
Lauri Himanen's avatar
Lauri Himanen committed
35
git clone https://gitlab.mpcdf.mpg.de/nomad-lab/nomad-meta-info.git
Lauri Himanen's avatar
Lauri Himanen committed
36
```