Project tools
The OpenScPCA project supports UNIX-based platforms and is largely structured around the use of Git (and GitHub). Therefore, as a contributor, there are several tools you will need to be familiar with, including:
- Git
- This documentation section explains how to use Git as a contributor, specifically using the GitKraken GUI
- The terminal, also known as the command line
- Writing text in markdown
- Software management platforms, including conda and, if you plan to develop R-based modules,
renv
- We use conda and
renv
to manage installation of module-specific software dependencies and packages
- We use conda and
- We additionally use Docker and a separate Nextflow workflow to ensure reproducibility, but OpenScPCA contributors are not required to use these platforms unless they choose
Tip
Are there other project tools you'd like to see documentation for?
Let us know by filing an issue to request additional documentation!