STAR

(β˜… 2,236)

RNA-seq aligner

  • .gitignore
  • .gitmodules
  • .travis.yml
  • _config.yml
  • CHANGES.md
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • LICENSE
  • README.md
  • RELEASEnotes.md

# Installation Guide

1. Get the code
git clone https://github.com/alexdobin/STAR

Downloads the entire project code from GitHub to your computer.

cd STAR

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
docker build -f extras/docker/Dockerfile -t star .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 star

Runs the built image as an actual container.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make STAR

Compiles the code based on the generated build configuration to produce an executable.

make STAR CXXFLAGS_SIMD=sse

Compiles the code based on the generated build configuration to produce an executable.

make STARforMacStatic CXX=/path/to/gcc

Compiles the code based on the generated build configuration to produce an executable.

make CXXFLAGSextra=-march=native

Compiles the code based on the generated build configuration to produce an executable.

make LDFLAGSextra=-flto CXXFLAGSextra="-flto -march=native"

Compiles the code based on the generated build configuration to produce an executable.

βœ… If it finishes without errors, it worked. Try running the generated executable directly.

Pulled directly from this repo's README.

// repository documentation