Specify Tutorial
Sample LFR File
Going line by line:
module[module name]([inputs and outputs]);
[module name]
Whatever the user would like to name their module. No spaces.
[inputs and outputs]
finput : Flow inputs of the design. These correspond to ports where fluids flow into the chip. Flow inputs (eg fi1) can be named however user desires. No spaces in names. Must have comma after each flow input.
cinput : Control inputs of the design. These correspond to ports where pumps control valve states from. Flow inputs (eg ci1) can be named however the user desires. No spaces in names. Must have comma after each control input (including the final one!).
foutput : Flow outputs of the design. These correspond to ports where fluids flow out of the the chip. Flow ouputs (eg fo1) can be named however the user desires. No spaces in names. Must have comma after each flow output, with the exception of the final output.
fchannel [flow channels];
flow channels : These define the connections between each flow layer microfluidic component. channels can be named however the user desires, with commas delimiting each. No spaces in names. Semicolon after the end of the line.
assign [output channel] = [input channel] [relation symbol] [optional additional input channels];
[output channel] : The channel which is are described as the result of the relation between input channel[s]. Must be either a previously defined channel, or an output.
[input channel] : A channel that serves as an input to the microfluidic relationship described by the assign statement. Must be either a previously defined channel, or an input.
[relation symbol] : A symbol which corresponds to a microfluidic component defined in the provided User Constraints File (UCF)
[optional additional input channels] : Additional inputs can be placed into the relation, as long as the microfluidic component the symbol describes allows it. This restriction on number of inputs to a relation based on the microfluidic component in question will soon be lifted with an update to the LFR translator.
endmodule : Final line which terminates all LFR files.
The UCF is a library of microfluidic components which LFR symbols represent. A default UCF is provided with Neptune. Advanced users can edit their UCF from the default values (tutorial coming soon)