2020-12-18 17:03:58 +01:00
|
|
|
|
![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/carissalow/rapids?style=plastic)
|
2020-03-31 01:05:30 +02:00
|
|
|
|
[![Snakemake](https://img.shields.io/badge/snakemake-≥5.7.1-brightgreen.svg?style=flat)](https://snakemake.readthedocs.io)
|
2020-11-30 19:51:05 +01:00
|
|
|
|
[![Documentation Status](https://github.com/carissalow/rapids/workflows/docs/badge.svg)](https://www.rapids.science/)
|
2020-12-18 17:03:58 +01:00
|
|
|
|
![tests](https://github.com/carissalow/rapids/workflows/tests/badge.svg)
|
2020-11-30 19:51:05 +01:00
|
|
|
|
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](code_of_conduct.md)
|
2020-03-31 01:05:30 +02:00
|
|
|
|
|
2020-03-05 20:53:54 +01:00
|
|
|
|
# RAPIDS
|
2019-10-22 19:11:01 +02:00
|
|
|
|
|
2020-03-05 20:53:54 +01:00
|
|
|
|
**R**eproducible **A**nalysis **Pi**peline for **D**ata **S**treams
|
2019-10-22 19:11:01 +02:00
|
|
|
|
|
2020-12-12 23:51:01 +01:00
|
|
|
|
For more information refer to our [documentation](http://www.rapids.science)
|
2019-10-22 19:11:01 +02:00
|
|
|
|
|
2020-03-05 20:53:54 +01:00
|
|
|
|
By [MoSHI](https://www.moshi.pitt.edu/), [University of Pittsburgh](https://www.pitt.edu/)
|
2022-03-30 18:17:07 +02:00
|
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
|
|
|
|
|
|
For RAPIDS installation refer to to the [documentation](https://www.rapids.science/1.8/setup/installation/)
|
|
|
|
|
|
2022-07-07 17:30:07 +02:00
|
|
|
|
## For the installation of the Docker version
|
|
|
|
|
|
|
|
|
|
1. Follow the [instructions](https://www.rapids.science/1.8/setup/installation/) to setup RAPIDS via Docker (from scratch).
|
|
|
|
|
|
|
|
|
|
2. Delete current contents in /rapids/ folder when in a container session.
|
|
|
|
|
```
|
|
|
|
|
cd ..
|
|
|
|
|
rm -rf rapids/{*,.*}
|
|
|
|
|
cd rapids
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
3. Clone RAPIDS workspace from Git and checkout a specific branch.
|
|
|
|
|
```
|
|
|
|
|
git clone "https://repo.ijs.si/junoslukan/rapids.git" .
|
|
|
|
|
git checkout <branch_name>
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
4. Install missing “libpq-dev” dependency with bash.
|
|
|
|
|
```
|
|
|
|
|
apt-get update -y
|
|
|
|
|
apt-get install -y libpq-dev
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
5. Restore R venv.
|
|
|
|
|
Type R to go to the interactive R session and then:
|
|
|
|
|
```
|
|
|
|
|
renv::restore()
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
6. Install cr-features module
|
2022-07-20 15:51:22 +02:00
|
|
|
|
From: https://repo.ijs.si/matjazbostic/calculatingfeatures.git -> branch modifications_for_rapids.
|
2022-07-08 12:40:08 +02:00
|
|
|
|
Then follow the "cr-features module" section below.
|
2022-07-07 17:30:07 +02:00
|
|
|
|
|
|
|
|
|
7. Install all required packages from environment.yml, prune also deletes conda packages not present in environment file.
|
2022-07-20 15:51:22 +02:00
|
|
|
|
```
|
|
|
|
|
conda env update --file environment.yml –prune
|
|
|
|
|
```
|
2022-07-07 17:30:07 +02:00
|
|
|
|
|
|
|
|
|
8. If you wish to update your R or Python venvs.
|
|
|
|
|
```
|
2022-07-08 12:40:08 +02:00
|
|
|
|
R in interactive session:
|
|
|
|
|
renv::snapshot()
|
|
|
|
|
Python:
|
2022-07-20 15:51:22 +02:00
|
|
|
|
conda env export --no-builds | sed 's/^.*libgfortran.*$/ - libgfortran/' | sed 's/^.*mkl=.*$/ - mkl/' > environment.yml
|
2022-07-07 17:30:07 +02:00
|
|
|
|
```
|
|
|
|
|
|
2022-07-08 12:40:08 +02:00
|
|
|
|
## cr-features module
|
2022-03-30 18:17:07 +02:00
|
|
|
|
|
2022-07-20 15:51:22 +02:00
|
|
|
|
This RAPIDS extension uses cr-features library accessible [here](https://repo.ijs.si/matjazbostic/calculatingfeatures).
|
2022-03-30 18:17:07 +02:00
|
|
|
|
|
2022-07-20 15:51:22 +02:00
|
|
|
|
To use cr-features library:
|
2022-07-07 17:30:07 +02:00
|
|
|
|
|
2022-03-30 18:17:07 +02:00
|
|
|
|
- Follow the installation instructions in the [README.md](https://repo.ijs.si/matjazbostic/calculatingfeatures/-/blob/master/README.md).
|
|
|
|
|
|
|
|
|
|
- Copy built calculatingfeatures folder into the RAPIDS workspace.
|
|
|
|
|
|
2022-07-20 15:51:22 +02:00
|
|
|
|
- Install the cr-features package by:
|
2022-03-30 18:17:07 +02:00
|
|
|
|
```
|
2022-07-20 15:51:22 +02:00
|
|
|
|
pip install path/to/the/calculatingfeatures/folder
|
|
|
|
|
e.g. pip install ./calculatingfeatures if the folder is copied to main parent directory
|
|
|
|
|
cr-features package has to be built and installed everytime to get the newest version.
|
|
|
|
|
Or an the newest version of the docker image must be used.
|
2022-03-30 18:17:07 +02:00
|
|
|
|
```
|