Neptune

Getting Started Guide

This is the getting orientation guide to the massive set of repositories that are a part of the Neptune Project developed at CIDAR Lab. Please follow the dev guide section to seamlessly setup the repositories.

Repository List

1. Fluigi Cloud - node.js based serverside Framework that resides on AWS
2. Neptune-UI - vue.js based frontend framework
3. pyFluigi - Place & Route manager system
4. pyLFR - LFR Compiler for implemented in python (not yet public)
5. pyparchmint - ParchMINT data model library in python
6. pyMINT - MINT Compiler and Datamodel
7. LFR TestCases - Repository of LFR Test Cases used for Testing the LFR compiler
8. MINT TestCases - Repository of the MINT Test Cases used for testing the MINT Compiler

Cloning and tracking for development

First, run the following commands for recursively cloning all the required dependencies for the project and set up the sub repo branch tracking for development:

git clone --recurse-submodules -j8 https://github.com/cidarlab/Neptune
cd Neptune
git submodule update --init
git submodule foreach -q --recursive 'git checkout $(git config -f $toplevel/.gitmodules submodule.$name.branch || echo master)'

Submodule Recipe Reference

How to Build

Since there are there many packages in the project, building this project is going to be a pain. Use the docker to complete builds, but please be aware that this can take a substantial amount of time to build.

TBA Rest of the guide...

Contact

Reach out to @rkrishnasanka for more details.

Running individual services

docker run -i containername:dev --env-file=myenvfile

docker exec -ti <container name> /bin/bash

Running Pritives-Server Service

Typically when one needs to convert MINT files to JSON, one needs to run the Pritives-Server service to pull component parameters from the 3DuF Implementation

docker-compose up primitives-server

This server can then be accessed at http://localhost:6060