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


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
20

21
# Local Install
22 23 24

The following instructions were tested on Ubuntu 14.04.

25 26 27
The modules used for parser development are located under the 'nomadcore'
package. If you wish to setup this package locally, you can do so by first
installing the required dependencies:
Lauri Himanen's avatar
Lauri Himanen committed
28 29

```sh
30
pip install -r requirements.txt
Lauri Himanen's avatar
Lauri Himanen committed
31 32
```

33
and then installing the package itself with the provided installation script:
Lauri Himanen's avatar
Lauri Himanen committed
34 35

```sh
36
python setup.py develop --user
Lauri Himanen's avatar
Update  
Lauri Himanen committed
37
```
Lauri Himanen's avatar
Lauri Himanen committed
38

39
After this the package will be available to import by simply calling
Lauri Himanen's avatar
Lauri Himanen committed
40 41

```python
42
import nomadcore
Lauri Himanen's avatar
Update  
Lauri Himanen committed
43
```
Lauri Himanen's avatar
Lauri Himanen committed
44

45 46 47
in python. The development mode also means that the latest version of the code
is used, so any updates from git will automatically be available. You can
install a static snapshot by using 'install' instead of 'develop'.