Code Monkey home page Code Monkey logo

gater's Introduction

Gater | Minerva Analysis

About

This is an openseadragon based Cellular Image Viewing and Analysis Tool. It is built with a python Flask backend and a Node.js javascript frontend.

Executables (for Users)

Releases can be found here: https://github.com/labsyspharm/gater/releases These are executables for Windows and MacOS that can be run locally without any installations.

Running as a Docker container

  • Build image: docker build -t gating .
  • Run image with mounted path: docker run --rm -dp 8000:8000 -v [source path]:/[target path] gating

where

  • --rm cleans up the container after it finishes executing
  • -v mounts the "present working directory" (containing your data) to be /data inside the container. This is necessary in order to import your data via the import page.
  • -dp forwards the port 8000

Once the container is running, go to http://localhost:8000/ in your web browser. To import your imaging files in the import gui type in the mounted /data/..

Clone and Run Codebase (for Developers)

1. Checkout Project

git clone https://github.com/labsyspharm/minerva_analysis.git

2. Checkout Necessary Branch

  • For Gating, run git checkout gating
  • Run git pull to make sure everything is up to date

3. Conda Install Instructions.

Install Conda
  • Install miniconda or conda.
  • Create env: conda env create -f requirements.yml
Activate Environment
  • Active environment: conda activate minerva_analysis
Start the Server
  • python run.py - Runs the webserver
Start the Server
  • Access the tool via http://localhost:8000/

(4. Node.js installation and packages)

This step is only needed when you plan to edit js code. The codebase already included bundled js files.

  • Install Node.js, then navigate to /minerva_analysis/client and run npm install to install all packages listed in package.json.
  • Run npm run start to package the Javascript, or run npm run watch if you plan on editing dependencies

Packaging/Bundling Code as Executable (for Developers)

Any tagged commit to a branch will trigger a build, where tag == commit message. This will appear under releases. Note building may take ~10 min.

Tagging Conventions: All release tags should look like v{version_number}_{branch_name}.

gater's People

Contributors

dependabot[bot] avatar github-actions[bot] avatar jessupjs avatar kruegert avatar nchuynh avatar simonwarchol avatar thejohnhoffer avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.