cromshell

(โ˜… 53)

CLI for interacting with Cromwell servers

  • .bumpversion.cfg
  • .coveragerc
  • .gitignore
  • .isort.cfg
  • .pylintrc
  • .readthedocs.yml
  • dev-requirements.txt
  • LICENSE
  • MANIFEST.in
  • pyproject.toml
  • README.md
  • requirements.txt
  • test-requirements.txt
  • tox.ini

# Installation Guide

1. Get the code
git clone https://github.com/broadinstitute/cromshell

Downloads the entire project code from GitHub to your computer.

cd cromshell

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Homebrew A package manager for macOS/Linux.
  • Python 3 Python is required to use pip.
brew tap broadinstitute/dsp

Registers this project's repository (tap) with Homebrew.

brew install cromshell

Installs the pre-built package via Homebrew โ€” no source build required.

pip install cromshell

Installs the package published on PyPI directly โ€” no need to clone the source.

pip install .

Installs the package published on PyPI directly โ€” no need to clone the source.

โœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install cromshell

Installs the package published on PyPI directly โ€” no need to clone the source.

pip install .

Installs the package published on PyPI directly โ€” no need to clone the source.

pip uninstall cromshell

Type this command into your terminal and run it.

โœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation