mnFlow documentation

Micro-nanoflow (mnFlow) library is aimed at providing the community with tools for design and modeling of micro-nanofluidic chips. The current focus of the project is on Deterministic Lateral Displacement (DLD) [1] structures. In particular, the DLD design automation (DDA) tool aims at automating the entire process of design and production of computer-aided design (CAD) files for DLD-based micro-nanofluidic chips. The produced CAD files can be used for computational modeling, optimization, and manufacturing of DLD devices.

Check out the Usage section for further information, including how to install the package as well as a quick start. The Tutorials section also includes a set of examples to introduce various features of the package. Finally, the Manual section describes how the package works under the hood.

Note

This project is under development.

Contents:

• Usage
  • Installation
  • Quick start
• Tutorials
  • Benchmarks from original paper
  • Benchmarks from original paper (ESI)
• Manual
  • Core
  • Block
  • Multistage
  • Condenser-and-Sorter
• API
  • mnflow.mfda.cad.dld.theme.core.DLD
  • mnflow.mfda.cad.dld.theme.block.DLD
  • mnflow.mfda.cad.dld.theme.multistage.DLD
  • mnflow.mfda.cad.dld.theme.condenser_sorter.DLD

Acknowledgments

This project utilizes the packages mentioned in the following. We gratefully acknowledge their contributions to this project.

• klayout: For creating CAD layouts.

• numpy: For numerical computations.

• pillow: For creating image of layouts.

• scipy: For solving equations.

• matplotlib: For data visualization

• black, flake8, and isort: For linting and formatting codes.

• git and pre-commit: For revision control and pre-commit hooks, respectively.

• sphinx, and sphinx-rtd-theme: For creating docs.

• pytest, and pytest-cov: For creating test cases.

Refs

[1] L. R. Huang, E. C. Cox, R. H. Austin and J. C. Sturm, Science, 2004, 304, 987-990.