3liv / Phinch

About

Phinch is an open-source framework for visualizing biological data, funded by a grant from the Alfred P. Sloan foundation. This project represents an interdisciplinary collaboration between Pitch Interactive, a data visualization studio in Oakland, CA, and biological researchers at UC Davis. Whether it's genes, proteins, or microbial species, Phinch provides an interactive visualization tool that allows users to explore and manipulate large biological datasets.

Install

First, clone the repo via git:

git clone https://github.com/PhinchApp/Phinch.git your-project-name

Then install dependencies with yarn or npm install.

$ cd phinch
$ yarn

You'll also need to install hdf5 in order to be able to load hdf5 biom files. You can obtain it from the HDF Group, or from a package manager like brew:

$ brew install hdf5

Finally, here's the tricky part. Phinch uses a python script in the biomhandler folder to load hdf5 biom files. To make Phinch easy to install, we use PyInstaller to package that script into a standablone executable. Follow these steps to generate the executable:

cd biomhandler
virtualenv ./virtualenv
source ./virtualenv/bin/activate
cat requirements.txt | xargs -n 1 -L 1 pip install
pyinstaller biomhandler.spec

Run

$ npm run dev

Packaging

Package apps for the local platform with:

$ npm run package

Mozilla Global Sprint: Round 5 of Mozilla Open Leaders

Mozilla Open Leaders information

Code of Conduct

Check out our Code of Conduct

Contribution Guidelines

Check out our Contribution Guidelines

License

The BSD 2-Clause License