Installation¶

Require Python 3.3+, setuptools, and pip. Other Python versions have not been tested.

Note

Python 3.4+ should bundle with setuptools and pip, but that’s not always the case on some Linux Platform. For Debian/Ubuntu to install setuptools and pip,

sudo apt-get install python3-setuptools python3-pip

If that’s a self-compiled Python, try

python3 -m ensurepip

For older Python versions, download get-pip.py and run it.

python get-pip.py

Dependencies¶

pathlib (for Python 3.3 and below)
PyYAML
docopt
Jinja2

If one wants to have colorful logging messages, extra packages are required:

colorlog (or colorlog[windows] on Windows)

Install latest stable version¶

pip install ngcloud

To get colorful logging message dependencies as well, use

pip install ngcloud[color]

Build from source¶

NGCloud use Gulp.js, CoffeeScript, and Stylus to build report templates’ CSS and JS with building automation. All frontend dependencies are managed independently by npm.

To build from source, Node.js and npm are required. Check their homepage for their installation.

git clone https://github.com/BioCloud-TW/ngcloud.git
cd template_dev
npm install -g gulp
npm install

cd ..  # back to ngcloud source root
python setup.py install

Run test¶

Require nose

nosetest ngcloud

Build this doc¶

You need to installed NGCloud before building the doc. Extra dependencies are

NGCloud source is needed. To install them,

cd docs
pip install -r requirements.txt
make html

Documentation will be under docs/_build/html/index.html

For PDF requires XeLaTeX,

make xelatex