Documentation for #-CAD and Python Libraries¶
This is the documentation for #-CAD (Hash-CAD), a unified CAD and scripting system for DNA megastructure (origami) design, handle library generation, and visualization, and various python libraries for manipulating DNA megastructures and generating orthogonal sequence libraries.
Developed in the William Shih Lab at the Dana-Farber Cancer Institute and the Wyss Institute at Harvard.
Getting Started¶
-
Learn how to install and use #-CAD. Quick-access install instructions here.
-
Programmatically manipulate megastructures, export to Echo, and generate graphics.
-
Contribute to #-CAD's programming development.
-
Generate orthogonal DNA sequence libraries for assembly handles using graph-based algorithms.
Documentation Sections¶
For Users¶
| Section | Description |
|---|---|
| User Guide | Desktop application tutorials, keyboard shortcuts, and workflow guides |
| Installation | Download and install #-CAD and the python libraries for macOS, Windows, or Linux |
Python Libraries¶
| Library | Description |
|---|---|
| crisscross | Core Python library for megastructure design, Echo export, and graphics |
| orthoseq_generator | Orthogonal sequence generation for assembly handle libraries |
| eqcorr2d | High-performance C engine for computing parasitic valency matches |
| API Reference | Complete Python API reference |
For #-CAD Developers¶
| Section | Description |
|---|---|
| Flutter Developer Guide | Architecture, state management, and contribution guidelines |
| Flutter API | Auto-generated Dart API documentation |
Quick Links¶
- Source Code: github.com/mattaq31/Hash-CAD
- PyPI Package: crisscross-kit
- Issues & Feedback: GitHub Issues
- #-CAD Web: hash-cad.com
Quick Installation Reference¶
Download the latest release from GitHub Releases.
Citation
If you use #-CAD or the various Python libraries in your research, please cite our work (#-CAD is currently a preprint, please find the paper here on BioRxiv).