From 42d84e5b6b40e9de026a42d6d22c2a80a49c2b1a Mon Sep 17 00:00:00 2001 From: "Himanen, Lauri (himanel1)" <lauri.himanen@aalto.fi> Date: Mon, 4 Jan 2016 09:29:27 +0100 Subject: [PATCH] update --- README.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index f4e21ce..523fcff 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,7 @@ -# python-common -This repository contains the common components for building a parser for the NOMAD project. +# __python-common__ +This repository contains the common components for building a parser for the NOMAD project. The following instructions were tested on Ubuntu 14.04. -## NOTE -These instructions were tested on Ubuntu 14.04. - -## Quick Install +# Quick Install The modules used for parser development are located under the 'nomadcore' package. You can setup this package in any way you like, but a simple installation script 'setup.py' is provided for ease of use. It will install the nomadcore package along with the needed dependencies. You can install the package in development mode by calling the terminal command ```sh @@ -19,14 +16,16 @@ import nomadcore 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'. -## Manual install +# Manual install This package depends on other python libraries which are declared in 'requirements.txt'. The requirements can be installed simply by calling the terminal command ```sh pip install -r requirements.txt ``` -in the folder where the file is located. In order to use the nomadcore package you have to add the directory to PYTHONPATH so that python knows where to look for it. This can be achieved temporarily by using a script like this +in the folder where the file is located. + +In order to use the nomadcore package you have to add the directory to PYTHONPATH so that python knows where to look for it. This can be achieved temporarily by using a script like this ```python import sys -- GitLab