Skip to content

Latest commit

 

History

History
61 lines (35 loc) · 3.4 KB

README.md

File metadata and controls

61 lines (35 loc) · 3.4 KB

ySBGN - Bidirectional translation between GraphML (yEd Graph Editor) and SBGN-ML

The aim is to provide the most accurate translation for metabolic networks between GraphML (yEd) and SBGN-ML Process Description file formats. Translation in both direction is possible. This project should ultimately be integrated into the SBFC.

Compatible formats:

  • SBGN-ML 0.2 (Process Description)
  • yEd 3.17.1

To find more information, please check the Wiki. A brief comparison of the tools we used to edit biological diagrams in the SBGN Process Description language is available in the Editors page. The translation mapping rules are briefly described in Translation page. The latest release including executable application and source files can be directly downloaded from the Releases page.

Known issues are shown in the Issues section and the limitations of the tool are listed on the Limitations page.

Requirements

  • Java 8 (with JavaFX if you want to use the GUI)
  • Maven (tested with Maven 3.5)

Install

After cloning the repository and getting into its directory:

mvn clean

mvn install

A small GUI is also provided as the main class of the package. It can be launched by double clicking on the jar or by directly calling the package with java -jar. Be sure to have JavaFX working in your Java distribution.

The executable jar can be directly downloaded from the Release page.

How to contribute

If you have any suggestions or want to report a bug, don't hesitate to create an issue. Pull requests and all forms of contribution will be warmly welcomed.

Contributors

Irina Balaur, EISBM, Lyon, France - specified the translation rules, developed the code and the GUI

Alexander Mazein, EISBM, Lyon, France - idea, advice on the translation rules, project coordination

Ludovic Roy, EISBM, Lyon, France - advised on the SBGN-ML format

Vasundra Touré, NTNU, Trondheim, Norway - advised on specific issues

Charles Auffray, EISBM, Lyon, France - strategic advice

Useful links

Acknowledgements

This work has been supported by the Innovative Medicines Initiative Joint Undertaking under grant agreement no. IMI 115446 (eTRIKS), resources of which are composed of financial contribution from the European Union’s Seventh Framework Programme (FP7/2007-2013) and EFPIA companies.