Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
This is in preparation for the release
  • Loading branch information
rkrishnasanka committed Feb 24, 2019
1 parent cffd052 commit 94770fa
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 11 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
BSD 2-Clause License

Copyright (c) 2017, CIDAR LAB
Copyright (c) 2019, CIDAR LAB
All rights reserved.

Redistribution and use in source and binary forms, with or without
Expand Down
35 changes: 25 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,32 @@
![3DuF Logo](http://3duf.org/img/logo.png)
![3DuF Logo](http://3duf.org/img/logo.png | width=500)

An Interactive Design Tool for Continuous Flow Microfluidic Devices
An Interactive Design Tool for Continuous Flow Microfluidic Devices - [3DuF.org](http://3duf.org)

## Try it out
## About

[3DuF.org](http://3duf.org)
The design of microfluidic Lab on a Chip (LoC) systems is an onerous task requiring specialized skills in fluid dynamics, mechanical design drafting, and manufacturing. Engineers face significant challenges during the labor-intensive process of designing microfluidic devices, with very few specialized tools that help automate the process. Typical design iterations require the engineer to research the architecture, manually draft the device layout, optimize for manufacturing processes and manually calculate and program the valve sequences that operate the microfluidic device. The problem compounds when the devices are intended for executing biological assays where engineers not only have to test the functionality of the chip but are also required to optimize them for robust performance. In this paper, we present an interactive tool for designing continuous flow microfluidic devices. \tool~ is the first completely open source interactive microfluidic system designer that readily supports state of the art design automation algorithms. Through various case studies, we show \tool~ can be used to reproduce designs from literature, provide metrics for evaluating microfluidic design complexity and showcase how \tool~ is a platform for integrating a wide assortment of engineering techniques used in the design of microfluidic devices as a part of the standard design work-flow.

## Usage

### Design Environment

## Usage
![UI](/doc/ui.png | width=800)

### Keyboard Shortcuts

### 2D Navigation
- Pan Canvas: `middle mouse button` and ` arrow ` keys
- Reset Canvas View: ` F ` key
- Activate Select Tool/ Deselect Selected Components: ` Esc `
- Activate Component Copy Mode: ` ctrl+C ` -\> ` ctrl+V `
- Undo Last Edit: ` ctrl+Z `
- Select All: ` ctrl+A `
- Save JSON file: ` ctrl+ S`


### Installation and Debugging

[Instructions for installation, build, and test are in the wiki.](https://github.com/CIDARLAB/3DuF/wiki/Building-and-Testing-3DuF)

Hold the middle mouse button to pan. Scroll the middle mouse to zoom.

### Selecting and Configuring Feature Types

Expand Down Expand Up @@ -41,15 +55,16 @@ Under ```Save``` in the main menu, click a to download the current design in the

After saving a device design to JSON, drag and drop it from your computer onto the device canvas to load it.

## Development Setup
## Component Library

![UI](/doc/mint-primitives.png | width=800)

[Instructions for installation, build, and test are in the wiki.](https://github.com/CIDARLAB/3DuF/wiki/Building-and-Testing-3DuF)

### License

BSD 2-Clause License

Copyright (c) 2017, CIDAR LAB
Copyright (c) 2019, CIDAR LAB
All rights reserved.

See [LICENSE](/LICENSE) for more information.
Expand Down
Binary file added doc/mint-primitives.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/ui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 94770fa

Please sign in to comment.