Skip to content

Latest commit

 

History

History
163 lines (116 loc) · 7.3 KB

README.md

File metadata and controls

163 lines (116 loc) · 7.3 KB
Raw

Build Status

Introduction

This is the repository for Cello v2, the successor of the Cello genetic circuit design software. This repository hosts the core of Cello v2, a command line tool that implements the circuit design routines. If you are looking for the web application, it is hosted at CIDARLAB/Cello-v2-webapp.

Installation

Options

You have a few options to install Cello:

  1. Get the Docker image from Docker hub and run it.
  2. Install the runtime dependencies, download a JAR file from the releases page of this repository, run the JAR file.
  3. Install the developer dependencies, clone the contents of this repository, and build the webapp from source.

The procedure for each option is described in the sections below.

In the future, Cello will be hosted with a GUI on cellocad.org. For now, the original version of Cello remains hosted there. The webapp for Cello-v2 is in development.

(Option 1) Docker

Download and install Docker.

Pull the image:

docker pull cidarlab/cello-dnacompiler:latest

Run the image, replacing fields surrounded by <> with files or directories appropriate for your use case:

docker run --rm -i \
-v <ABSOLUTE_PATH_TO_LOCAL_INPUT_DIRECTORY>:/root/input \
-v <ABSOLUTE_PATH_TO_LOCAL_OUTPUT_DIRECTORY>:/root/output \
-t cidarlab/cello-dnacompiler:latest \
java -classpath /root/app.jar org.cellocad.v2.DNACompiler.runtime.Main \
-inputNetlist /root/input/<VERILOG_FILE_IN_INPUT_DIRECTORY> \
-options /root/input/<OPTIONS_FILE_IN_INPUT_DIRECTORY> \
-userConstraintsFile /root/input/<UCF_IN_INPUT_DIRECTORY> \
-inputSensorFile /root/input/<INPUT_SENSOR_FILE_IN_INPUT_DIRECTORY> \
-outputDeviceFile /root/input/<OUTPUT_DEVICE_FILE_IN_INPUT_DIRECTORY> \
-pythonEnv python \
-outputDir /root/output

See the sample-input directory in this repository for example Verilog files, UCFs, and option files. An example invocation with all fields completed (omitting the options switch, thus using defaults) might be:

docker run --rm -i \
-v /home/foobar/input:/root/input \
-v /home/foobar/output:/root/output \
-t cidarlab/cello-dnacompiler:latest \
java -classpath /root/app.jar org.cellocad.v2.DNACompiler.runtime.Main \
-inputNetlist /root/input/and.v \
-userConstraintsFile /root/input/Eco1C1G1T1.UCF.json \
-inputSensorFile /root/input/Eco1C1G1T1.input.json \
-outputDeviceFile /root/input/Eco1C1G1T1.output.json \
-pythonEnv python \
-outputDir /root/output

After execution, check the output directory for generated files.

(Option 2) Prepackaged JAR file

Runtime dependencies

  • Java JRE 8 (Oracle JRE) or Java JDK 8 (see above)
  • Python 3
  • Yosys
  • Graphviz
    • Linux: check your package manager
    • Mac OSX: via Homebrew: brew install graphviz
    • Windows:
      • download and install the latest executable package, e.g. graphviz-2.38.msi
      • add path to dot.exe, e.g. C:\Program Files (x86)\Graphvix2.38\bin, to %Path%
  • dnaplotlib
    • pip install dnaplotlib
  • (Optional) pycello-v2
    • To support experimental feature: RNAseq profile generation.
    • pip install git+https://github.com/CIDARLAB/pycello-v2
  • The latest JAR from the releases page of this repository, or the latest snapshot from Sonatype.

Execution

Replace fields surrounded by <> with files or directories appropriate for your use case:

java -classpath <JAR_FILE> org.cellocad.v2.DNACompiler.runtime.Main \
-inputNetlist <PATH_TO_VERILOG_FILE> \
-options <PATH_TO_OPTIONS_FILE> \
-userConstraintsFile <PATH_TO_UCF> \
-inputSensorFile <PATH_TO_INPUT_SENSOR_FILE> \
-outputDeviceFile <PATH_TO_OUTPUT_DEVICE_FILE> \
-pythonEnv <ABSOLUTE_PATH_TO_PYTHON_OR_NAME_OF_EXECUTABLE_IN_ENVIRONMENT_PATH> \
-outputDir <PATH_TO_OUTPUT_DIRECTORY>

See the sample-input directory in this repository for example Verilog files, UCFs, and option files. An example invocation with all fields completed (omitting the options switch, thus using defaults) might be:

java -classpath cello-dnacompiler-2.0.0-SNAPSHOT-jar-with-dependencies.jar org.cellocad.v2.DNACompiler.runtime.Main \
-inputNetlist and.v \
-userConstraintsFile Eco1C1G1T1.UCF.json \
-inputSensorFile Eco1C1G1T1.input.json \
-outputDeviceFile Eco1C1G1T1.output.json \
-pythonEnv python \
-outputDir /home/cello_user/output

(Option 3) Building from source

Runtime dependencies

  • Java JDK 8 (Oracle, OpenJDK)
  • All other dependencies from (Option 2) above.

  1. Clone the repository:

     git clone --recurse-submodules https://github.com/CIDARLAB/Cello-v2.git

  2. Build & package:

     cd Cello-v2/cello
 mvn clean package

Example execution

First go to the target directory:

cd cello-dnacompiler/target

Then proceed as in the Execution section from (Option 2) above.

Development

Code style

This project uses the Maven Checkstyle Plugin with a slightly relaxed version of google_checks.xml to enforce code style. If the code does not match the style requirements, maven will fail during the validate phase. If using Eclipse, you can use the Eclipse Checkstyle Plugin to show warnings when code does not meet the style requirements. You can also automatically format written code with the google-java-format, which can be used from the command line, or as a plugin in Eclipse or JetBrains IDEs.

Deployment

Sonatype OSS

  • mvn clean deploy -Pdeploy
  • See configuration in the parent pom.xml.

Docker Hub

  • Docker images are built and deployed automatically via Travis CI. See .travis.yml.

  • Manual:

    mvn docker:build
mvn docker:push