Skip to content

Latest commit

 

History

History
71 lines (55 loc) · 3.59 KB

README.md

File metadata and controls

71 lines (55 loc) · 3.59 KB
Raw

DataWarrior

DataWarrior is a program for interactive data analysis and visualization. While it is widely used by data analysts in general, it is particular useful for cheminformaticians, because chemical structures and reactions are native datatypes and because of its rich cheminformatics functionality.

DataWarrior runs on all major platforms. Pre-built installers exist for Linux, Macintosh and Windows. Software installers, documentation, sample data, and a support forum are available on www.openmolecules.org/datawarrior.

DataWarrior is built on the open-source projects OpenChemLib and FXMolViewer.

Dependencies

Apart from a working JDK8 with JavaFX, DataWarrior needs various free-to-use/open-source dependencies. All required dependency files are provided as part of this project in the ./lib folder. The most important ones are:

  • OpenChemLib: Cheminformatics base functionality to handle molecules and reactions
  • FXMolViewer: 3D-molecule & protein visualization, editing, interaction using JavaFX (includes Sunflow ray-tracer and MMTF to download and parse binary structure files from the PDB-database)
  • Batik: Support for SVG vector graphics
  • Database connectors for: MySQL, PostgreSQL, Oracle, Microsoft SQL-Server
  • Opsin: IUPAC name conversion to chemical structures
  • Substance Look&Feel: professionally designed user interface skin
  • Java Expression Parser: for calculating new column data using custom equations

How to download the project

git clone https://github.com/thsa/datawarrior.git

How to build the project

On Linux or Macintosh just run the 'buildDataWarrior' shell script.

How to run the project

After building the project just run the 'runDataWarrior' shell script.

Platform Integration

Ideally, DataWarrior should be installed in a platform specific way that registers its file extentions and causes proper file icon display. Installers for Linux, Macintosh, and Windows, which include proper platform integration, can be downloaded from www.openmolecules.org.

This platform integration is not (yet) part of this project. Thus, if you intend to run DataWarrior from self compiled source code and if you don't do the platform integration yourself, then you may still install DataWarrior with the official installer and afterwards replace the original datawarrior.jar file with the freshly built one.

Unfortunately, this does not work on Windows platforms, because a proper platform integration on Windows requires the application to be an .exe file. Therefore, on Windows the datawarrior.jar, the application icon and all document icons are embedded in the DataWarrior.exe file as resources.

Note: The datawarrior.jar file of the platform specific installers are shrunk with Proguard, to reduce the datawarrior.jar file size significantly be the removal of unused classes and methods from the byte code.

How to contribute

Contact the author under the e-mail shown on www.openmolecules.org

License

DataWarrior. Copyright (C) 2021 Idorsia Pharmaceuticals Ltd.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.