File: README

package info (click to toggle)
polyxmass-doc 0.8.5-2
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 6,672 kB
  • ctags: 89
  • sloc: sh: 3,501; makefile: 189
file content (147 lines) | stat: -rw-r--r-- 7,080 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
This file is part of the "GNU polyxmass" project.

The "GNU polyxmass" project is an official GNU project package (see
www.gnu.org) released ---in its entirety--- under the GNU General
Public License and was started at the Centre National de la Recherche
Scientifique (FRANCE), that granted me the formal authorization to
publish it under this Free Software License.

Copyright (C) 2000,2001,2002,2003 Filippo Rusconi

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

    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 2 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, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
    USA

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~



README:

GNU polyxmassdata is a platform-independent package that contains all
textual/graphical data required to run the GNU polyxmass software out of
the box.  Namely, GNU polyxmassdata contains configuration files describing
polymer chemistry for a number of polymer types commonly found in nature:
protein, dna, rna, saccharides. These polymer chemistry definitions are
examples, and should be carefully reviewed by the user of the GNU polyxmass
software, in order to make sure that they fulfill their task in the
best way. 

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
IMPORTANT NOTE: every file distributed along with the GNU
polyxmassdata package is distributed under the GNU General Public
License (see notice above). This is true even for files which do not
contain the GNU GPL notice, like the one written above.
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

A number of modules in the GNU polyxmass software project are based on
graphical displays of chemistry elements, like a polymer sequence is
displayed in the form of a properly arranged array of monomer images
(see www.polyxmass.org, section polyxedit to make sure you visualize
such a polymer sequence being edited). The little graphics that are
needed to display graphically a polymer sequence are contained in this
GNU polyxmassdata package. See for yourself the contents of the different
"protein", "dna", "rna", "saccharide" directories.

There are two different kinds of little graphics for the display of
the polymer sequence: each monomer referenced in the polymer chemistry
definition has one or two little graphics files:

- a '.png' file that is a simple raster graphics file. This is the most
  common graphics format known, with 'jpg' and a few others (we do not
  use them because there are software patents problems with them);
- a '.svg' file that is a scalar vector graphics file. This is a standard
  graphics file format that's being pushed forward by the www (W3C)
  consortium for use in the internet. That svg graphics file is scalable,
  which means that a program understanding this format will be able to
  render the graphics for any size asked by the user. This is how the
  polyxedit modules in the GNU polyxmass framework can dynamically resize
  the monomer icons in the polymer sequence editor without loosing
  image quality.

Each polymer definition may have its own set of graphics files to render
the monomer that are defined in the polymer definition file. All the
polymer definition-specific files are located in a directory that is
usually name by the name of the polymer definition, like "protein" or
"dna", for example.

The correspondence between a polymer definition type, like "protein",
for example, and the directory where the "protein"-specific files are
located is made a in very simple format file "poldefs-dictionary.dic",
that I include below for you to see how simple it is:


~~~~~~~~~~~ begin inclusion ~~~~~~~~~~~~~


# This file is part of the "GNU polyxmass" project.

# The "GNU polyxmass" project is an official GNU project package (see
# www.gnu.org) released ---in its entirety--- under the GNU General
# Public License and was started at the Centre National de la
# Recherche Scientifique (FRANCE), that granted me the formal
# authorization to publish it under this Free Software License.
 
# Copyright (C) 2000,2001,2002,2003 Filippo Rusconi

# This is the poldefs-dictionary.dic file where the correspondences
# between a polymer definition name and its file are made. Also, the
# pixmaps directory is listed for each polymer definition.  The format
# of the file is like this : 

# protein=protein.xml%protein-pixmaps 

# where 1) protein is the name of the polymer definition, 2)
# protein.xml and protein-pixmaps are respectively the name of the
# polymer definition file and the pixmaps directory name.  Each line
# starting with a '#' character is a comment and is ignored during
# parsing of this file. The file is case-sensitive.

protein=protein.xml%protein
long-protein=long-protein.xml%long-protein
dna=dna.xml%dna
rna=rna.xml%rna
saccharide=saccharide.xml%saccharide
ose=ose.xml%saccharide
peptide=peptide.xml%protein



~~~~~~~~~~~ end inclusion ~~~~~~~~~~~~~

What we see here is that the polymer definition type "protein" has all its
data located in the protein directory. But we also see that the "protein"
polymer definition type is defined in the "protein.xml" file. That is
a crucial piece of information indeed, because when a user opens a new
polymer sequence by reading the polymer sequence file from disk, the
program needs to know how to render the sequence, which means that it
needs to know were the graphics files are located. But in order to know
where the graphics files are located, it needs to know what it the polymer
definition type of the polymer sequence. To get to know this, the program
seeks a piece of data in the xml-formatted sequence file that indicates
what's the polymer type. In our example the polymer sequence file would
state: "this polymer sequence is a 'protein' sequence". Since the program
now knows that the polymer sequence file is a protein (and not, say, a
sugar sequence), it can render it by going to fetch the graphics files
in the "protein" directory. But it also can check that the sequence is
valid, by making sure that all the monomers are properly referenced and
described in the polymer definition type file "protein.xml".

This small introduction to the internal workings of the polyxmass software
project should make clear that the polyxmassdata package is essential
to the proper functioning of both the polyxedit graphical module and all
the other non-graphical modules (since the polymer definition files are
located in this polyxmassdata package).