Skip to content

Commit

Permalink
Updating install instructions and README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
apmechev committed Feb 20, 2018
1 parent c6e27b3 commit 3c83164
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 2 deletions.
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
[![Documentation Status](https://readthedocs.org/projects/grid-lrt/badge/?version=latest)](http://grid-lrt.readthedocs.io/en/latest/?badge=latest)
[![Build Status](https://travis-ci.org/apmechev/GRID_LRT.svg?branch=master)](https://travis-ci.org/apmechev/GRID_LRT)
[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
[![PyPI version](https://badge.fury.io/py/GRID-LRT.svg)](https://badge.fury.io/py/GRID-LRT)
[![alt text](http://apmechev.com/img/git_repos/GRID_LRT_clones.svg "github clones since 2017-01-25")](https://github.com/apmechev/github_clones_badge)


Expand Down Expand Up @@ -29,7 +30,20 @@ Requirements:

Installing:
============
To use the package, it is recommended to install it using the setup.py script:

Installing with pip
---------

The GRID LOFAR Reduction Tools are now available through pip:

```bash
pip install GRID_LRT

```

Manual build
------
Alternatively you should use the setup.py script to install the tools:

```
python setup.py build
Expand All @@ -44,6 +58,8 @@ python setup.py install --perfix={PATH_WHERE_TO_INSTALL_PACKAGE}

You have to make sure that this path 1. Exists, 2. Is in your PYTHONPATH and 3. Will be in your PYTHONPATH every time you enter your shell (add it to your ~/.bashrc)



Tutorial Notebook
==============

Expand Down
2 changes: 1 addition & 1 deletion docs/installing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Installation
************

Via Python Package (coming soon)
Via Python Package Index
==================

Install the package (or add it to your ``requirements.txt`` file):
Expand Down

0 comments on commit 3c83164

Please sign in to comment.