README 2.29 KB
Newer Older
pfeiffer's avatar
pfeiffer committed
1
This is the BESSY-scripts bundle.
pfeiffer's avatar
pfeiffer committed
2

3
4
You find here modules for perl and python and a collection of scripts that
hopefully will make your work easier.
pfeiffer's avatar
pfeiffer committed
5

franksen's avatar
franksen committed
6
7
8
How to make and install
=======================

9
10
Installation with make
----------------------
11

12
13
Basically files are installed with "make install". However, there are many
options how and where you install the files. 
14

15
16
17
18
The variables needed by make are defined in files whose names start with
"config". By default, make reads file "config". When you set variable
"BII_CONFIG" on the command line, you may specify a different configuration
file. 
franksen's avatar
franksen committed
19

20
21
22
23
Call for a generic installation::

  INSTALL_PREFIX=[DIR] make -sj install

24
25
26
Call for an installation at BESSY development hosts or the bessy control
system fileserver (HOST is the full qualified hostname e.g.
'stretch.acc.bessy.de')::
franksen's avatar
franksen committed
27

28
  BII_CONFIG=config.HOST.acc make -sj install
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

Installation with install.sh
----------------------------

File "install.sh" is here to make installation even easier.

First you have to make install.sh executable::

  chmod u+x install.sh

Then for a generic installation call::

  ./install.sh [DIR]

At BESSY (HZB) install on our development hosts with this command::

  ./install.sh
46

47
48
49
50
51
52
53
54
55
56
57
Running the scripts directly from the source directory
======================================================

In order to run the scripts directly from the source directory you have to
"source" the file SETENV-RUN-LOCAL.sh like shown here::

  . ./SETENV-RUN-LOCAL.sh

This feature is here for making it easier to debug the scripts, usually you
should do a regular install as described above.

franksen's avatar
franksen committed
58
59
60
Documentation
=============

pfeiffer's avatar
pfeiffer committed
61
62
You can find further Documentation here:

pfeiffer's avatar
pfeiffer committed
63
64
doc/txt/CONTENTS 
	list of all modules and scripts 
pfeiffer's avatar
pfeiffer committed
65

pfeiffer's avatar
pfeiffer committed
66
67
68
69
70
71
72
73
doc/txt/AUTHORS
	a list of who wrote what

DIRS    explanation of the directory-tree

doc/txt/INSTALL
	how to install the bundle 
	(only needed if you did a CVS checkout)
pfeiffer's avatar
pfeiffer committed
74

pfeiffer's avatar
pfeiffer committed
75
76
77
doc/txt/USE_PERL
	how to use the perl-modules of the bundle

pfeiffer's avatar
pfeiffer committed
78
79
80
LICENSE
	the text of the software license 

franksen's avatar
franksen committed
81
82
83
README
	The file you reading at the moment

84
85
HTML Documentation is created by "make" and installed with "make install".

86
87
88
89
90
91
92
License and copyright
=====================

Copyright (c) 2020 by 
`Helmholtz-Zentrum Berlin <https://www.helmholtz-berlin.de>`_.

This software of this project can be used under GPL v.3, see file "LICENSE".
franksen's avatar
franksen committed
93