Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
C
chipathlon
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Deploy
Releases
Model registry
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Holland Computing Center
chipathlon
Commits
857d585e
Commit
857d585e
authored
7 years ago
by
aknecht2
Browse files
Options
Downloads
Patches
Plain Diff
Updated installation documentation.
parent
6fc166b6
No related branches found
Branches containing commit
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
doc/source/installation.rst
+55
-6
55 additions, 6 deletions
doc/source/installation.rst
with
55 additions
and
6 deletions
doc/source/installation.rst
+
55
−
6
View file @
857d585e
Installation
==============
Installation is made much easier by using the pre-built
`anaconda <https://anaconda.org/>`_ packages. There are two different packages
located under the `hcc channel <https://anaconda.org/hcc>`_.
The chipathlon package contains all software necessary to run & generate
workflows. The chipathlon-client packages contains all software necessary to
generate workflows with the expectation that the execute host has the
necessary software installed. idr uses python3 however, so it must be
created in a separate environment. Once you have conda installed:
.. code-block:: bash
# Add the required channels for all software
conda config --add channels conda-forge
conda config --add channels r
conda config --add channels HCC
conda config --add channels bioconda
# Create the chip env with all software except idr
conda create -n chip python=2.7 chipathlon
# Create the idr environment
conda create -n idr python=3.5 idr
This will create the two environments necessary to run workflows. The chip
environment can also be used to generate and submit workflows:
.. code-block:: bash
# Activate chip env
source activate chip
# Generate the workflow
chip-gen...
Below is the full list of dependencies if you don't want to use conda.
Dependencies
^^^^^^^^^^^^
**Dependencies for chipathlon**
Dependencies for chipathlon
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* `Pegasus <http://pegasus.isi.edu/>`_
* `pymongo <https://api.mongodb.com/python/current/>`_
* `yaml <http://pyyaml.org/>`_
Dependencies for running workflows
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
**
Dependencies for running workflows
**
* `Gem <http://groups.csail.mit.edu/cgs/gem/>`_
* `Zerone <https://omictools.com/zerone-tool>`_
* `MACS2 <https://github.com/taoliu/MACS>`_
...
...
@@ -22,9 +57,23 @@ Dependencies for running workflows
* `picard <https://github.com/pezmaster31/bamtools>`_
* `bwa <http://bio-bwa.sourceforge.net>`_
* `bowtie2 <http://bowtie-bio.sourceforge.net/bowtie2/index.shtml>`_
* `idr <https://github.com/nboley/idr>`_
**Dependencies for building docs**
Dependencies for building docs
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* `Sphinx <http://www.sphinx-doc.org/en/stable/>`_
* `Sphinx Argparse <https://github.com/ribozz/sphinx-argparse>`_
* `Read the Docs Theme <https://github.com/rtfd/sphinx_rtd_theme>`_
Setting up bosco
^^^^^^^^^^^^^^^^^
To use bosco with the chipathlon-client package a small amount of setup must
be done first. Namely, adding the target cluster that you wish to use.
This can be done with the following command:
.. code-block:: bash
bosco_cluster -a USERNAME@HOST.org slurm
This will generate and copy ssh keys that will be used to transfer files
between your submit host and your execute host.
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment