File: tools.rst

package info (click to toggle)
apbs 3.4.1-7
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 199,188 kB
  • sloc: ansic: 284,988; cpp: 60,416; fortran: 44,896; xml: 13,895; sh: 13,838; python: 8,105; yacc: 2,922; makefile: 1,428; f90: 989; objc: 448; lex: 294; awk: 266; sed: 205; java: 134; csh: 79
file content (170 lines) | stat: -rw-r--r-- 3,607 bytes parent folder | download | duplicates (3)
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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
--------------------
Conversion utilities
--------------------

.. todo::  Update this documentation with the *new APBS syntax* (see :ref:`new_input_format`).

^^^^^^^^^^^^^^^
amber2charmm.sh
^^^^^^^^^^^^^^^

A bash script for converting AMBER atom names to CHARMM names.
Found in :file:`tools/conversion`

^^^^^^
del2dx
^^^^^^

Converts DelPhi-format map files (electrostatic potential, etc.) to APBS OpenDX format.
Found in :file:`tools/mesh`

^^^^^^
dx2mol
^^^^^^

Converts OpenDX format map files to MolMol format.
Found in :file:`tools/mesh`

^^^^^^^
dx2uhbd
^^^^^^^

Converts OpenDX format map files to UHBD format.
Found in :file:`tools/mesh`

^^^^^^^^^^^
qcd2pqr.awk
^^^^^^^^^^^

An awk script for converting from UHBD QCD format to PQR format.

----------------------
Benchmarking utilities
----------------------

^^^^^^^^^
benchmark
^^^^^^^^^

Benchmark file I/O for reading/writing scalar data.
Found in :file:`tools/mesh`

^^^^^^^^^^^^
uhbd_asc2bin
^^^^^^^^^^^^

Converts UHBD ASCII-format files to binary format.
Found in :file:`tools/mesh`

^^^^^^^^^^^^^^^^
WHATIF2AMBER.sed
^^^^^^^^^^^^^^^^

A sed script for converting WHATIF atoms names to the AMBER naming scheme.
Found in :file:`tools/conversion`

----------------------------
Setup and analysis utilities
----------------------------

^^^^^^^^
analysis
^^^^^^^^

Calculates various metrics from input scalar data.
Found in :file:`tools/mesh`

^^^^
born
^^^^

Calculate generalized Born forces and energies.
Found in :file:`tools/manip`

^^^^^^^
coulomb
^^^^^^^

Calculate Coulomb forces and energies.
Found in :file:`tools/manip`

.. _dxmath:

^^^^^^
dxmath
^^^^^^

Performs simple arithmetic operations with Cartesian grid data.  
This program takes as input a file with operations specified in a stack-based (RPN) manner.
For example, a command file which adds grid1 and grid2, multiplies the result by 5.3, adds grid4, subtracts 99.3 from the whole thing, and writes the result on grid5 would have the form:

.. code-block:: mathematica
   
   grid1
   grid2 +
   5.3 *
   grid4 +
   99.3 -
   grid5 =

The file names, scalar values, and operations must be separated by tabs, line breaks, or white space.
Comments can be included between the character # and a new line (in the usual shell script fashion).
Found in :file:`tools/mesh`

^^^^^^^^^^^
inputgen.py
^^^^^^^^^^^

Create an APBS input file using :ref:`psize` data.
Found in :file:`tools/manip`

^^^^^^^^^^^^^^^^^^^^
mergedx and mergedx2
^^^^^^^^^^^^^^^^^^^^

Combine multiple OpenDX files into a single resampled file.
:program:`mergedx2` can perform a number of grid manipulation operations, including:

* Combining multiple OpenDX map files
* Resampling of one or more OpenDX map files (for example to alter the grid spacing of separate OpenDX files for further manipulation)
* Extracting a subregion of an existing OpenDX map file.

Found in :file:`tools/mesh`

^^^^^^
mgmesh
^^^^^^

Prints out acceptable combinations of :doc:`input/old/elec/nlev` and :doc:`input/old/elec/dime` for multigrd calculations.
Found in :file:`tools/mesh`

^^^^^^^^^^
multivalue
^^^^^^^^^^

This program evaluates OpenDX scalar data at a series of user-specified points and returns the value of the data at each point.
Found in :file:`tools/mesh`

.. _psize:

^^^^^^^^
psize.py
^^^^^^^^

Suggest grid sizes and spacings for APBS given an input molecule.
Found in :file:`tools/manip`

^^^^^^^^^^
similarity
^^^^^^^^^^

Computes similarity between two scalar grid datasets.
Found in :file:`tools/mesh`

^^^^^^
smooth
^^^^^^

Convolve grid data with various filters.
Found in :file:`tools/mesh`