thenlevy / ensnano

ENSnano, a 3D graphical application for DNA nanostructures.
GNU General Public License v3.0
49 stars 6 forks source link

ensnano-logo

This is an archived repository. ENSnano's new repository can be found at https://github.com/ensnano/ensnano

About

ENSnano is a software for designing DNA nanostructures.

ENSnano takes up the concepts of existing DNA nanostructures design softwares such as cadnano and extends them with additional features. Notable features of ENSnano include

Currently, ENSnano can only produces sequences for DNA origamis.

For more details about ENSnano you can checkout the paper introducing it in the proceedings of the DNA27 conference:

ENSnano: a 3D modeling software for DNA nanostructures Nicolas Levy and Nicolas Schabanel. DNA 2021 Proceedings of the 27th International Conference on DNA Computing and Molecular Programming [ pdf ]

You can also see here the talk presented at the conference.

Installation

We try to frequently release binaries for Windows and MacOS.

Alternatively you can clone this repository and build the software from source, following instructions below:

Dependencies

All platforms

You need to have the latest Rust compiler installed. See this page.

Note: If you already have Cargo installed but face compilation issues, make sure that you have the latest version by running

rustup update

Linux

You need the GTK3 development packages and a C++ compiler to build the RFD dependency.

You also need to have the Vulkan driver for your graphic card installed. The installation method depends on your distribution and graphic card, but there should be a tutorial on the internet for any combination of those.

Compiling from source

Clone the repository:

git clone https://github.com/thenlevy/ensnano.git

Then run ENSnano with:

cd ensnano
cargo run --features=log_after_renderer_setup --release

Importing Cadnano/Scadnano files

ENSnano does not currently handles deletions/loops/insertions in its designs. Here is how these features are handled when importing a cadnano/scadnano file

Example

In this cadnano design, deleted nucleotides are removed and loops are replaced by single strands

cadnano_del_loop ensnano_del_loop

In this scadnano design, insertions and loopouts are replaced by single strands

scadnano_insert_loopout ensnano_insert_loopout

Troubleshooting

Compilations errors

Compilation errors may be happen when using an outdated version of the rust compiler. To solve this run

rustup update

It might also happen that you need to update ENSnano's dependencies before compiling. To do so, run

cargo update

Crash at startup on Windows

By default, ENSnano uses a Vulkan renderer on windows platforms that offers one. However this renderer does not work properly on some machines. For this reason it is also possible to use a DirectX12 renderer instead.

If your program crashes on startup, try using the binary

ensnano-windows-dx12

or, if you are compiling from source, use a DirectX12 renderer with

cargo run --release --features="dx12_only log_after_renderer_setup"

Third-party licenses

The licenses of the dependencies are listed in thirdparties/license.html

This software uses the following fonts which are distributed under the SIL OpenFont License

The font font/DejaVuSansMono.ttf is in public domain.