Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/synbiodex/libsbolj

Java Library for Synthetic Biology Open Language (SBOL)
https://github.com/synbiodex/libsbolj

Last synced: 4 days ago
JSON representation

Java Library for Synthetic Biology Open Language (SBOL)

Awesome Lists containing this project

README 

        
[![Build Status](https://travis-ci.org/SynBioDex/libSBOLj.svg?branch=master)](https://travis-ci.org/SynBioDex/libSBOLj)



[libSBOLj](https://github.com/SynBioDex/libSBOLj) provides the core Java interfaces and their implementation for 

the [Synthetic Biology Open Language (SBOL)](http://www.sbolstandard.org/sbolstandard/specification). The library provides an API to 

work with SBOL objects, the functionality to read and write SBOL documents as XML/RDF files, and a validator to check the 

correctness of SBOL models. 



# Using the libSBOLj library



## In a Maven project:



In a Maven project that utilizes the libSBOLj library, add a dependency in the Maven project's ```pom.xml``` file.



```



	org.sbolstandard

	libSBOLj

	2.4.0



```

 

## In a non-Maven project:



Download ```libSBOLj--withDependencies.jar``` from the latest github release.



## Running in the command line:



libSBOLj comes with a command-line interface (CLI) that can be used to validate SBOL files. You can execute 

```libSBOLj--withDependencies.jar``` to validate and convert files as follows.



```

java -jar libSBOLj--withDependencies.jar  -l 

```

    

If validation/conversion is successful, the program will print the contents of the input file in the specified language (SBOL1, SBOL2, GenBank, and FASTA). You can also output the result to a file. 



```

java -jar libSBOLj--withDependencies.jar  -l  -o 

```



One can also provide a URI using the -s flag for a TopLevel object, and only that object and all its dependencies will be output.



If validation fails with an error, there will be a message printed about the validation error.  The -f flag can be used to indicate that validation should continue after the first error, while the -d flag will provide a detailed error trace on a validation error.  



In addition to checking all required validation rules, it will also check if the URIs are compliant and whether the SBOL document is complete (i.e., all referenced objects are contained within the file).  These validation checks can be turned off with the -n and -i flags, respectively.  It is also possible to turn-on best practices checking using the -b flag.  



When the input file is being converted into SBOL 2.0, the conversion should be provided a default URI prefix.  It can also be provided a default version, if desired.  Finally, the -t flag will insert the type of top level objects into the URI during conversion, if desired.



```

java -jar libSBOLj--withDependencies.jar  -o  -p  -v 

```



Finally, it can be used to compare the equality of the contents of two SBOL files using the command below:

```

java -jar libSBOLj--withDependencies.jar  -e 

```



## Using the latest libSBOLj SNAPSHOT



### Getting the libSBOLj source



1. [Create](https://github.com/) a GitHub account.

2. [Setup](https://help.github.com/articles/set-up-git) Git on your machine.

3. [Clone](https://help.github.com/articles/cloning-a-repository/) the libSBOLj GitHub repository to your machine.

4. Retrieve the SBOLTestSuite Submodule using the instructions below. 



### Retrieving SBOLTestSuite Submodule



```

git submodule update --init --recursive

```



### Compiling and Packaging libSBOLj 



1. [Setup](http://maven.apache.org/download.cgi) Apache Maven. A tutorial on using Apache Maven is provided [here](http://maven.apache.org/guides/getting-started/index.html).



2. In the command line, change to the libSBOLj directory (e.g. ```cd /path/to/libSBOLj```) and execute the following command



```

mvn package

```



This will compile the libSBOLj source files, package the compiled source into a libSBOLj JAR file (```libSBOLj--SNAPSHOT-withDependencies.jar```), and place the JAR file into the ```core2/target``` sub-directory.