Code Monkey home page Code Monkey logo

draeger-lab / sbml2latex Goto Github PK

View Code? Open in Web Editor NEW
5.0 4.0 3.0 184.58 MB

SBML2LATEX is a tool to convert files in the System Biology Markup Language SBML) format into LATEX files. A convenient online version is available, which allows the user to directly generate report from SBML in form of PDF or TeX, which can be further processed to various file types including DVI, PS, EPS, GIF, JPG, or PNG. SBML2LATEX can also be downloaded and used locally in batch mode or interactively with its Graphical User Interface or several command line options. The purpose of SBML2LATEX is to provide a way to read the contents of XML-based SBML files. This is helpful and important for, e.g., error detection, proofreading and model communication.

License: GNU General Public License v3.0

TeX 80.56% HTML 1.66% Java 17.78%
sbml latex reporting documentation-generator pdf

sbml2latex's Introduction

SBML2LaTeX

Conversion of SBML files into human-readable reports

License (GPL version 3) Stable version DOI

Authors: Andreas Dräger, Hannes Planatscher, Dieudonné Motsou Wouamba, Adrian Schröder, Michael Hucka, Lukas Endler, Martin Golebiewski, Wolfgang Müller, and Andreas Zell


SBML2LATEX is a tool to convert files in the System Biology Markup Language SBML) format into LATEX files. A convenient online version is available, which allows the user to directly generate a report from SBML in the form of PDF or TeX, which can be further processed to various file types including DVI, PS, EPS, GIF, JPG, or PNG. SBML2LATEX can also be downloaded and used locally in batch mode or interactively with its Graphical User Interface or several command line options. The purpose of SBML2LATEX is to provide a way to read the contents of XML-based SBML files. It is helpful and important for, e.g., error detection, proofreading and model communication.

Please cite: Dräger A, Planatscher H, Wouamba DM, Schröder A, Hucka M, Endler L, Golebiewski M, Müller W, and Zell A: “SBML2LATEX: Conversion of SBML files into human-readable reports”, Bioinformatics 2009. [ DOI ], [ PDF ]


Time line

  • New release: SBML2LATEX version 0.9.9 can now be downloaded at the download section. This new version has become much simpler, the file is smaller and can directly be launched by double clicking. It is based on the latest release of JSBML (version 0.8-rc1). See the release notes for new features and bug fixes. - (draeger - 2011-12-15 15:48)
  • SBML2LATEX version 0.9.8 is now available on the download page. This new version supports SBML Level 3 Version 1 and is based on JSBML. It provides a new option to write the entire differential equation system instead of links to the rate equations only and is able to directly create PDF files using LATEX and to open the result in the system's default PDF viewer. - (draeger - 2011-03-08 8:47)
  • Full support of SBML Level 2 Version 4: SBML2LATEX version 0.9.6 was released that uses libSBML 3.3.1 and therefore supports the new specification of SBML. The new release contains a convenient bash script that automatically downloads and installs libSBML 3.3.1 with Xerces 3.0.0 on your system. - (draeger - 2009-02-04 14:29)
  • Web Service available: This web service provides a convenient way of using SBML2LATEX and creates various file formats including PDF, PS, DVI and TeX. - (draeger - 2008-12-16 13:15)
  • First Release: Launch the download link. Note that libSBML 3.2 or higher is required for this program. - (draeger - 2008-12-16 09:23)

Thanks for support

We would like to thank the SBML team (see http://sbml.org), and the LATEX3 team, especially the developer of the breqn package that introduces automatic line breaks into equations, Morten Høgholm. We are grateful to the developers of HTML2LATEX because for the conversion of XHTML elements within the SBML notes element, SBML2LATEX includes a modified version of this program (see http://htmltolatex.sourceforge.net). We would also like to thank the JSBML team for developing this new project. Older versions of SBML2LATEX include software developed by the JDOM Project (http://www.jdom.org).

Funding

This project was funded by the Federal Ministry of Education and Research (Germany, Bundesministerium für Bildung und Forschung, BMBF) in the projects National Genome Research Network (Nationales Genomforschungsnetz, NGFN-Plus), HepatoSys “Kompetenznetzwerk Systembiologie des Hepatozyten”, and the Virtual Liver Network and supported by the Center for Bioinformatics Tuebingen (Zentrum für Bioinformatik Tübingen, ZBIT). The German federal state Baden-Württenberg funded the Tübinger Bioinformatik-Grid project that enabled us to provide the convenient SBML2LATEX web service.

Installation & Usage

SBML2LATEX is build with ant. The available build targets are

  • ant compile: compiles the source code
  • ant jar: generates the SBML2LaTeX.jar file
  • ant bigjar: generates the SBML2LaTeX-with-dependencies.jar file
  • ant javadoc: generates the API documentation
  • ant clean: cleans up the directory

To build and run SBML2LATEX use:

ant bigjar
java -jar build/SBML2LaTeX-1.0-with-dependencies.jar 

The latex interpreter must be set to the location of pdflatex.

sbml2latex's People

Contributors

draeger avatar matthiaskoenig avatar niko-rodrigue avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

sbml2latex's Issues

Unclear installation & usage guide

How can I install SBML2LaTeX exactly?
The guide on the GitHub documentation README does not tell me exactly how to install SBML2LaTeX. I am not sure in which folder I should be while calling the command line commands, which system is required or if there are even different installation methods per OS required.

How to use SBML2LaTeX?
From the GitHub documentation README I cannot tell how I would use the program after the installation. What would be a typical call? Or do I get a GUI for the program if I have it installed successfully? Even with a GUI an example usage would be helpful.

Exception: Property fast is not defined in reaction for Level 3 and Version 2.

Hi all,
I tried to run SBML2Latex on a model of mine (see attached). When I try to create the report I get a Property fast is not defined in reaction fro Level 3 and Version 2 exception. No report is generated.

tiny_example_8.xml.zip

Steps to reproduce:

git clone https://github.com/draeger-lab/SBML2LaTeX.git
cd SBML2LaTeX
ant bigjar
java -jar build/SBML2LaTeX-1.0-with-dependencies.jar 

Output

------------------------------------------------------------
SBML2LaTeX version 1.0
Copyright © 2007-2013 University of Tuebingen,
Center for Bioinformatics Tuebingen (ZBIT).
This program comes with ABSOLUTELY NO WARRANTY.
This is free software, and you are welcome
to redistribute it under certain conditions.
See http://www.gnu.org/licenses/gpl.html.
------------------------------------------------------------
Feb 13, 2019 7:11:31 PM de.zbit.io.fileformat.FormatIdentification init --- WARNING: Could not load format identification magic byte file.
Feb 13, 2019 7:12:47 PM de.zbit.sbml.gui.SBMLReadingTask doInBackground --- INFO: Reading time: 0.32 s
Feb 13, 2019 7:12:47 PM de.zbit.io.OpenFile openFile --- WARNING: Error opening file ../locales/linebreakdef.sty. Please check if this file exists and if you have reading access to it.
Feb 13, 2019 7:12:47 PM cz.kebrt.html2latex.ParserHandler startElement --- WARNING: cz.kebrt.html2latex.NoItemException: Cannot find specified configuration item "message".
Feb 13, 2019 7:12:47 PM cz.kebrt.html2latex.ParserHandler endElement --- WARNING: Cannot find specified configuration item "message".
Feb 13, 2019 7:12:47 PM de.zbit.gui.GUITools showErrorMessage --- WARNING: Property fast is not defined in reaction for Level 3 and Version 2.
java.util.concurrent.ExecutionException: Property fast is not defined in reaction for Level 3 and Version 2.
	at java.util.concurrent.FutureTask.report(FutureTask.java:122)
	at java.util.concurrent.FutureTask.get(FutureTask.java:192)
	at javax.swing.SwingWorker.get(SwingWorker.java:602)
	at org.sbml.tolatex.gui.SBML2LaTeXworker.done(SBML2LaTeXworker.java:72)
	at javax.swing.SwingWorker$5.run(SwingWorker.java:737)
	at javax.swing.SwingWorker$DoSubmitAccumulativeRunnable.run(SwingWorker.java:832)
	at sun.swing.AccumulativeRunnable.run(AccumulativeRunnable.java:112)
	at javax.swing.SwingWorker$DoSubmitAccumulativeRunnable.actionPerformed(SwingWorker.java:842)
	at javax.swing.Timer.fireActionPerformed(Timer.java:313)
	at javax.swing.Timer$DoPostEvent.run(Timer.java:245)
	at java.awt.event.InvocationEvent.dispatch(InvocationEvent.java:311)
	at java.awt.EventQueue.dispatchEventImpl(EventQueue.java:758)
	at java.awt.EventQueue.access$500(EventQueue.java:97)
	at java.awt.EventQueue$3.run(EventQueue.java:709)
	at java.awt.EventQueue$3.run(EventQueue.java:703)
	at java.security.AccessController.doPrivileged(Native Method)
	at java.security.ProtectionDomain$JavaSecurityAccessImpl.doIntersectionPrivilege(ProtectionDomain.java:74)
	at java.awt.EventQueue.dispatchEvent(EventQueue.java:728)
	at java.awt.EventDispatchThread.pumpOneEventForFilters(EventDispatchThread.java:205)
	at java.awt.EventDispatchThread.pumpEventsForFilter(EventDispatchThread.java:116)
	at java.awt.EventDispatchThread.pumpEventsForHierarchy(EventDispatchThread.java:105)
	at java.awt.EventDispatchThread.pumpEvents(EventDispatchThread.java:101)
	at java.awt.EventDispatchThread.pumpEvents(EventDispatchThread.java:93)
	at java.awt.EventDispatchThread.run(EventDispatchThread.java:82)
Caused by: Property fast is not defined in reaction for Level 3 and Version 2.
	at org.sbml.jsbml.Reaction.getFast(Reaction.java:597)
	at org.sbml.tolatex.io.LaTeXReportGenerator.format(LaTeXReportGenerator.java:3354)
	at org.sbml.tolatex.io.LaTeXReportGenerator.formatReactions(LaTeXReportGenerator.java:2739)
	at org.sbml.tolatex.io.LaTeXReportGenerator.format(LaTeXReportGenerator.java:1065)
	at org.sbml.tolatex.io.LaTeXReportGenerator.format(LaTeXReportGenerator.java:1555)
	at org.sbml.tolatex.io.LaTeXReportGenerator.format(LaTeXReportGenerator.java:1673)
	at org.sbml.tolatex.SBML2LaTeX.toLaTeXreport(SBML2LaTeX.java:401)
	at org.sbml.tolatex.SBML2LaTeX.convert(SBML2LaTeX.java:190)
	at org.sbml.tolatex.gui.SBML2LaTeXworker.doInBackground(SBML2LaTeXworker.java:63)
	at org.sbml.tolatex.gui.SBML2LaTeXworker.doInBackground(SBML2LaTeXworker.java:41)
	at javax.swing.SwingWorker$1.call(SwingWorker.java:295)
	at java.util.concurrent.FutureTask.run(FutureTask.java:266)
	at javax.swing.SwingWorker.run(SwingWorker.java:334)
	at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1149)
	at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:624)
	at java.lang.Thread.run(Thread.java:748)

PDF logo cannot be resolved on linux

The following line results in a NullPointerException, because the logo is not copied in the bigjar.

FileTools.copyStream(SBML2LaTeX.class.getResourceAsStream("gui/img/SBML2LaTeX.pdf"), logoFile);

Just opening so I can close the issue afterwards.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.