README

   1 The VAMSAS Client\r
   2 =================\r
   3 \r
   4 This is an LGPLed Java implementation of the VAMSAS framework for \r
   5 bioinformatics application data exchange interoperation. \r
   6 VAMSAS is a pseudo-acronym, and is short for 'Visualization and Analysis \r
   7 of Molecular Sequences, Alignments and Structures'. \r
   8 The client is the product of an eScience research project funded by the\r
   9 UK Biotechnology and Biological Sciences Research Council which\r
  10 aimed to enable interoperation between visualization and analysis tools\r
  11 that deal with DNA, protein sequences, alignments, and molecular structures.\r
  12 \r
  13 The framework model is language independent - but this \r
  14 java prototype was developed for incorporation in the \r
  15 three sister programs (Jalview, TOPALi and AstexViewer@EBI-MSD)\r
  16 involved in the vamsas project (http://www.vamsas.ac.uk).\r
  17 \r
  18 Directory structure and Build Notes\r
  19 -----------------------------------\r
  20 Java source lives under src, runtime dependencies under lib and resources,\r
  21 compile time dependencies (which need to be added to the ant build classpath) \r
  22 reside in tools, and license details for dependencies are described in CONTRIB.\r
  23 Ant 1.7 has been verified to work with the provided build.xml.\r
  24 \r
  25 API and schema documentation can be found under the docs directory, \r
  26 along with a variety of (not entirely up to date) notes made during \r
  27 the development of the code. The schemas directory contains the vamsas document\r
  28 XML model, plus a couple of legacy XML documents. The demo directory also contains \r
  29 some older demonstration data. Finally, the test directory is made conspicuous via\r
  30 its emptiness (sorry!). \r
  31 \r
  32 A documented demonstration client (uk.ac.vamsas.test.ExampleApplication) based\r
  33 on the Jalview/VAMSAS control logic shows how the VAMSAS client code is intended \r
  34 to be used, but it does not yet demonstrate all aspects of the interchange model.\r
  35    \r
  36 For more information, please contact me, or any of the other developers \r
  37 directly, or via their program's own email discussion list.\r
  38 \r
  39 Jim Procter.\r
  40 7th May 2009.\r
  41 \r
  42 The other VAMSAS coders: Dominik Lindner, Pierre Marguerite, Iain Milne, Andrew Waterhouse.\r
  43 The VAMSAS project researchers: Geoff Barton, David Martin, David Marshall, Tom Oldfield, Frank Wright.\r