phenopackets/phenopacket-schema

Name: phenopacket-schema

Owner: PhenoPackets

Description: Repository for the inlined phenopacket schema

Created: 2018-03-19 11:49:19.0

Updated: 2018-05-16 16:11:46.0

Pushed: 2018-05-16 16:11:44.0

Homepage: null

Size: 117

Language: Java

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

Phenopacket schema

Build Status

Repository for the inlined phenopacket schema

This is a re-defined version of the original phenopacket with a more individual-centric approach. This new approach was taken in order to simplify the code required to represent and manipulate the data and also better represent this sort of data as it is in day to day use.

Currently this is very much work in progress and breaking changes will occur. Once we have settled on something stable we will draft a 1.0.0-RELEASE and thereafter stick to semantic versioning semantics.

Building

The project can be built using the awesome Takari maven wrapper which requires no local maven installation. The only requirement for the build is to have a working java installation and network access.

To do this `cd` to the project root and run the wrapper scripts:

mvnw clean install

or

mvnw.cmd clean install
Sign artefacts for release

There is a `release-sign-artifacts` profile which can be triggered with the command

mvnw clean install -DperformRelease=true
Java, Python and C++ artefacts

Building the project will automatically compile Java, Python and C++ artefacts. The Java jar file can be directly used in any Java project. For Python or C++ the build artefacts can be found at

et/generated-sources/protobuf/python

and

et/generated-sources/protobuf/cpp

Other languages will need to compile the files in `src/main/proto` to their desired language. The protobuf developer site has examples on how to do this, e.g GO or C#. Protobuf also supports a host of other languages.


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.