Skip to content

Commit 1f7eed8

Browse files
authored
Merge pull request #40 from jyucsiro/add-instructions-readme
updating README with instructions to build and run
2 parents e248387 + 9bebd38 commit 1f7eed8

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,31 @@
33
[![Build Status](https://api.travis-ci.org/repositories/binary-array-ld/bald.svg?branch=master)](http://travis-ci.org/binary-array-ld/bald/branches)
44

55
A Python library for validating and managing binary array linked data files.
6+
7+
## Pre-requisites
8+
9+
* netCDF - see https://gist.github.com/perrette/cd815d03830b53e24c82 for installing on Ubuntu
10+
* python 3
11+
* miniconda
12+
13+
Suggested configuration steps
14+
```
15+
conda create -n ncld-bald
16+
conda config --add channels conda-forge
17+
conda config --add channels bioconda
18+
conda config --set show_channel_urls True
19+
source activate ncld-bald
20+
```
21+
22+
## Quickstart
23+
24+
```
25+
#install required modules
26+
$ conda install --quiet --file requirements.txt
27+
28+
#install the bald module
29+
$ python setup.py --quiet install
30+
31+
#running the tests
32+
$ python -m unittest discover -s bald.tests -v
33+
```

0 commit comments

Comments
 (0)