Read Me

"The Analyses Database" - Main README file
Document revision date: 2021-10-30
==========================================


INTRODUCTION

Analytical laboratories are producing data at a rate that makes the use 
of mass storage media indispensable. At the time when this software was 
written (2000), analytical data were often archived onto CD-ROM and DVD-ROM, 
but information about the corresponding individual analyses was often 
logged with very different tools, such as text files,
paper notebooks, and miscellaneous commercial databases.

In addition, many laboratories use analytical instruments from different
manufacturers, on different software and hardware platforms (MS Windows,
Macintosh, Unix, Linux, ...), and all are constantly producing data,
each in a proprietary format. Thus, the use of a common approach for
data entry, archival and retrieval is indispensable.


WHAT IS THIS ?

_The Analyses Database_ is a comprehensive "toolbox" of several
programs to archive and to track files, and it is particularly
suitable for backup and archival of data obtained from analytical
instruments. It was described in a paper by J. Hau and L. Fay,
"Practical Approach to Archival and Retrieval of Analytical Data
in the Laboratory", published in Analyst 126 (2001), 1194-1199
(DOI: <http://dx.doi.org/10.1039/b102017j>)

The database used here is set up using freely accessible tools such
as the MySQL database engine, the Apache web server in connection
with the PHP scripting language, and the Linux operating system.

To ensure appropriate user-friendliness, the application is accessible
from any workplace via Intranet while still ensuring safe, restricted
access (login and password). The code generated is conform to publicly
available standards and does _not_ use any browser-specific code, so
the application is accessible with any browser and on any platform.

In addition, this solution does not rely on a proprietary solution
but employs publicly recognised standard formats and protocols.
It is freely available under the terms and conditions of the GNU
Public License (GPL), thus being open for extensions and custom
modifications.


WHAT YOU GET

This software comprises:

- in the directory WinNT/, some batch scripts to verify a freshly
  burned archive CD-ROM under MS-Windows NT. See the README.txt
  file in this directory.

- in the directory linux/, instructions to set up a database that
  holds central data about all analyses performed and their backup
  location, and the script files needed to interact with this
  database (which should be located on a central server) from
  any workplace on Intranet.
  This installation requires that you have the rights (and that you
  know how ;-) to install files on a Linux system. See the
  README.linux file in this directory.

- A "User's Manual" and a "Technical Reference".

- In the directory parser/, several parsers to extract metadata from 
  data files ... notably: 
  - HP/Agilent ChemStation
  - Finnigan ICIS2
  - Finnigan/Thermo Xcalibur 
  - Waters/Micromass MassLynx 3.x/4.x
  - Bruker Autoflex
  - The Shrader System (TSS) 


LATEST CHANGES

2002-12-28: Batch files now also tested with MS Windows 2000 Pro; added
            a corresponding comment.

2003-01-22: Stylistic changes in the manuals; content remains unchanged.
            Bugfix in adb.php that prevented the user from logging in
            once the wrong credentials were given.

2003-02-04: Minor bugfix in the batch files (CD_LOGDIR).

2003-03-04: Improved determination of the link to the "previous" and
            "next" entries. Improved display of the tables (CSS changed).

2003-04-02: Improved table structure: 'Backup' table now allows filing
            of "meta-data" such as sample text, comment text and
            acquisition Date & Time. The software to extract this
            information is under development ...

2003-05-20: Some bugfixes (related to import of metadata).

2004-08:    Major changes due to use of PHP4.

2005-01-04: License now GPL *v2*.

2005-08-25: Added demo database.

2009-03-03: Now hosted at sourceforge.net. Documentation updated, 
 	    no technical changes.

2009-03-07: Added metadata parsers.

2021-10-30: updated contact info in the documentation. 



CONTRIBUTION

If you find any bugs or observe some "behaviour" that is not mentioned in 
the manual, please file a bug report via the sourceforge.net project page.

If possible, submit not only a bug report but also a bug fix ;-),



LICENSE

This software and its documentation are Copyright (C) 2001...2009 by Joerg Hau.

This program is free software; you can redistribute it and/or modify it
under the terms of version 2 of the GNU General Public License as published 
by the Free Software Foundation. See the file LICENSE for details.

If you use this program (or *any* part of it) in another application, note
that the resulting application becomes also GPL. In other words, GPL is a
"contaminating" license.

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 (file
LICENSE) for more details.


OBTAINING THE PROGRAM

The latest version can be obtained from the project page on sourceforge.net:

    http://labdb.sourceforge.net/


AUTHOR

	Dr Jörg Hau, PMP
	Route du Marchairuz 29
	CH-1188 St-George
	Switzerland
	code at schweizerschrauber.ch


Thank you for your interest, and ... have fun!

--eof--