NAME
hier - filesystem hierarchy of Antelope software
DESCRIPTION
This briefly describes the organization of the files in the Antelope
software. Basically, the organization is quite similar to the standard
UNIX organization of /usr.
All the directories required by the software fall under a single root
directory, which may be placed anywhere. The software knows this location
via an environment variable ANTELOPE. Most programs run only with this
variable set properly.
Because there are many dynamic libraries in the distribution,
it is desirable to have a suggested absolute path for installation.
That path is "/opt/antelope".
Standard releases of perl and tcl appear under /opt/antelope.
The data directory contains release independent data for the rtdemo examples
and some example databases.
Under /opt/antelope is a directory
corresponding to the Antelope release, e.g. /opt/antelope/5.10.
Under this directory, there is a
somewhat familiar set of subdirectories, and a few plain files.
PLAIN FILES
antelope.html
This file is an html index to all the Antelope documentation; use your
browser (e.g. firefox, safari, opera, ..) to find a variety of information.
Changes.txt
This seeks to describe the important changes from the previous version of Antelope
to the current release.
README.txt
A brief introduction to Antelope, focused on the initial installation and
setup.
Release.txt
Shows the version of the operating system, compilers and other tools used
to create this release.
setup.csh
setup.sh
Files which are sourced to setup the environment properly so that Antelope
can be used. See
setup.csh(1)
DIRECTORIES
bin
This directory contains all the executables; it should normally be a part of
your path (setting your environment is taken care of by sourcing $ANTELOPE/setup.csh
or $ANTELOPE/setup.sh, depending on your shell).
demo
Setup files for various canned demos of realtime systems are kept here.
cd1 |
generate/receive cd1 data |
gsn |
receive gsn data, run realtime earthquake location |
iris-dmc |
receive data from realtime sources at DMC |
socalif |
see realtime system in action with actual earthquakes recorded in Southern California |
status |
collect computer system information onto orb |
doc
other forms (usually pdf files) of documentation for the programs and/or libraries. The
tutorial for datascope may be found here.
example
example contains a variety of example programs in
various languages, including c, perl, and tcl/tk.
include
This directory contains all the public include files required to develop
code using the libraries from lib.
lib
This directory contains the dynamic libraries used by most Antelope programs,
and against which your programs may be linked.
local
This directory doesn't appear in the distribution; however,
it's a good place to establish local modifications and additions
to the Antelope distribution. Underneath local would
appear directories like bin, lib, data and man, containing
programs developed at the local site.
man
manual pages for most of the programs and libraries
man/html
html versions of the man pages.
patches
patched
The initially empty directory patches contains patches downloaded from BRTT,
while the initially empty directory patched contains files describing each patch,
after the patch has been applied. Thus patched is a record of applied patches.
static
A few static libraries are included in this directory; these are needed only
for some development.
data
This directory contains data files required by the programs. These range from
parameter files, to tcl and perl subroutines, to data files for maps and fonts.
Some of the
major directories under data are:
maps |
geographic map database |
perl |
perl subroutines for Antelope |
pf |
parameter files |
schemas |
Datascope schema files. |
tables |
travel time tables for location codes |
tcl |
tcl/tk subroutines for Antelope |
autodrm |
autodrm(1) help files |
doc |
dbdoc(1), txform(1), fixman(1) auxiliary files |
env |
environment setting files for tcl interpreters |
evproc |
perl routines for evproc(3p) |
fonts.bin |
fonts for niceplot(3f) routines |
gmt |
dbgme files |
icons |
huge variety of icons |
instruments |
dbbuild parameter files describing sensors and dataloggers |
java |
java libraries |
ldlibs |
database for ldlibs(1) |
maps |
various map databases |
marmot |
marmot setups for Q330's |
matlab |
matlab interface routines |
perl |
perl libraries and extensions |
pf |
parameter files |
php |
php library |
pkt |
files for rebuilding libPkt to add packet types |
regions |
databases for the Flinn-Engdahl geographic and seismic regions |
responses |
response files for various datalogger (fir filters) and sensors |
schemas |
Datascope schemas |
system |
scripts for starting Antelope at boot time |
tables |
travel time tables |
tcl |
tcl libraries |
templates |
simple program examples and headers for some scripts |
units |
xunits(1) database |
SEE ALSO
antelope(1)
antelope(3)
antelopemakefile(5)
antelopeenv(5)
manpage(1)
mkmk(1)
template(1)
BUGS AND CAVEATS
The hierarchy is still flexible.
AUTHOR
Daniel Quinlan