Skip to content

Latest commit

 

History

History
21 lines (17 loc) · 2.07 KB

TESTINFO.md

File metadata and controls

21 lines (17 loc) · 2.07 KB

Information for User Testing

Round 1: v0.1.2-beta

Features
  • Currently I have only tested most aspects of the pipeline as a pipeline, running an individual sub-modules alone may still be a bit buggy in how the inputs are passed
  • This works best on a supercomputer -- if you need access and are a member of the Rutter lab, fill out this form and have Jared submit it to CHPC @ [email protected] or whatever relevant form the application suggests (sorry, I can't view the application since I already have an account)
  • Most features of XPRESSpipe are documented here; however, if you notice something missing or a mistake, please submit an issue request
Requests
  • If you find an issue, it is easiest for me to address if you submit an issue on GitHub
    • When filling out an issue, please describe the issue in detail, what you expect as output, and relevant output or log files (that were output in the output directory you specified). You should be able to attach these files when submitting an issue
  • If you find a feature is missing you would like to see implemented, submit an issue
  • After you have finished playing around with the software, please send me an email or slack describing your impressions, ease of use, etc
Installation
  • While Docker Images exist for XPRESSpipe, it may be best to download the latest version directly
  • Running python setup.py install will handle dependency installation

##### Getting Started
- Please refer to [this](https://xpresspipe.readthedocs.io/en/latest/content/general-usage.html) page and [this](https://xpresspipe.readthedocs.io/en/latest/content/reference-building.html) page in the docs to help with getting started