Task #7874: replace README, add INSTALL, COPYING (GPLv3), remove out-of-place,...

Task #7874: replace README, add INSTALL, COPYING (GPLv3), remove out-of-place, out-dated releases.txt. INSTALL can be extended later.
parent d5a22ccf
......@@ -4025,7 +4025,6 @@ MAC/_System/lofar29.journal -text svneol=native#application/octet-stream
MAC/_System/lofar29.sysconf -text svneol=native#application/octet-stream
MAC/_System/lofar30.journal -text svneol=native#application/octet-stream
MAC/_System/lofar30.sysconf -text svneol=native#application/octet-stream
/README -text
RTCP/Cobalt/BrokenAntennaInfo/CMakeLists.txt -text
RTCP/Cobalt/BrokenAntennaInfo/test/CMakeLists.txt -text
RTCP/Cobalt/BrokenAntennaInfo/test/debugbeaminfo.py -text
......
This diff is collapsed.
LOFAR (LOw Frequency ARray) Software Repository - INSTALL
=========================================================
Installation instructions for LOFAR software.
Supported Systems
-----------------
- Linux (distributions in use at ASTRON are Ubuntu, Mint, CentOS)
- Mac OS X (reasonably recent should work, also with LLVM/Clang)
Install from OS Packages
------------------------
Somewhere in 2015, there will be Debian/Ubuntu binary packages of various LOFAR
software packages and their dependencies (including casacore).
This is so much easier to do and support than the manual way described below
that we *strongly advise* all users to try this first. If this fails, ask for
help (see README) instead of resorting to a manual build from source.
<ppa link + apt-get install, once it's in place, add pkg >
Dependencies
------------
If you install pre-built Debian/Ubuntu/... packages (highly advised),
all dependencies will come along automatically.
If you build manually from source (disadvised, unless you are a developer),
CMake needs to be able to find all dependencies. Please first try to install
dependencies using your OS package manager. Only if unavailable or out-of-date,
try to build from source.
The most prominent dependency you likely need and may need to build from source
is casacore (casacore, casacore-data-update, and possibly python-casacore), from
https://github.com/casacore
Manual Build and Install from Source (quick summary)
------------------------------------
- SVN checkout a release or trunk from https://svn.astron.nl/LOFAR/ into
e.g. $HOME/LOFAR/
- To install the usual offline data reduction packages into e.g. $HOME/local/,
try the following command.
This only ends succesfully once CMake can find all required dependencies.
mkdir -p LOFAR-build/gnu_opt # last directory must be {gnu|clang}_{debug|opt}
cd LOFAR-build/gnu_opt
cmake -DCMAKE_INSTALL_PREFIX="$HOME/local" -DBUILD_PACKAGES="DP3 Calibration Imager PyBDSM" -DUSE_OPENMP=ON "$HOME/LOFAR"
- Build and install by running:
make -j 4
make install # with sufficient privileges
- Optionally, run the regression tests:
ctest -j 4
All tests should pass, however, some packages require certain hardware or
software (e.g. RTCP needs CUDA GPUs) to pass.
- You may want to add the installation path bin/ to your $PATH
Changes made in this release of OTDB
------------------------------------
LOFAR (LOw Frequency ARray) Software Repository - README
========================================================
The metadata of the trees is extended with 4 fields:
ADD COLUMN groupID INTEGER,
ADD COLUMN processType VARCHAR(20),
ADD COLUMN processSubtype VARCHAR(120),
ADD COLUMN strategy VARCHAR(30);
The LOFAR repository contains some of the software packages to operate
the LOFAR radio telescope and process its measurement output.
This has inpact on the treeInfo structure used by several sql functions.
The new treeInfo SQL structure is:
CREATE TYPE treeInfo AS (
treeID INT4, -- OTDBtree.treeID%TYPE,
momID INT4,
>> groupID INT4,
classification INT2, -- classification.ID%TYPE,
creator VARCHAR(20), -- OTDBuser.username%TYPE,
creationDate timestamp(0),
type INT2, -- treetype.ID%TYPE,
state INT2, -- treestate.ID%TYPE,
originalTree INT4, -- OTDBtree.treeID%TYPE,
campaign VARCHAR(30), -- campaign.name%TYPE,
starttime timestamp(0),
stoptime timestamp(0),
>> processType VARCHAR(20),
>> processSubtype VARCHAR(120),
>> strategy VARCHAR(30),
description TEXT
);
LOFAR is operated by ASTRON, the Netherlands Institute for Radio Astronomy.
For more information, see http://www.astron.nl/ and http://www.lofar.org/
The new C++ class is:
class OTDBtree {
public:
OTDBtree() : itsTreeID(0), itsMomID(0) {};
~OTDBtree() {};
Source code is available at https://svn.astron.nl/LOFAR
treeIDType treeID() const { return (itsTreeID); }
treeIDType momID() const { return (itsMomID); }
>> treeIDType groupID;
classifType classification; // development / test / operational
string creator;
ptime creationDate;
treeType type; // hardware / VItemplate / VHtree
treeState state; // idle / configure / ... / active / ...
>> string processType; // Maintenance / Reservation / Observation / ..
>> string processSubtype; // UVmeasurement / PulsarPipeline / ...
>> string strategy; // restricted free text
string description; // free text
Repository web interface: https://svn.astron.nl/viewvc/LOFAR/
// -- VIC only --
treeIDType originalTree;
string campaign;
ptime starttime;
ptime stoptime;
...
}
The affected functions are:
getTreeGroup
getTreesInPeriod
getExecutableTrees
getTreeInfo
getTreeList
setMomInfo
Top-level LOFAR Project Content (incomplete summary)
-------------------------------
The interface of the last 2 functions are changed:
CEP/ CEntral Processing software
CEP/DP3/ Pre-processing: flagging, averaging, demixing, ...
CEP/Calibration/ Self-calibration: BBS, antenna response, ...
CEP/Imager/ Imager
CEP/PyBDSM/ Source finder
CMake/ CMake build helper scripts
CMakeLists.txt Top-level CMake build script
COPYING License text
INSTALL Build and installation instructions
LCS/ LOFAR Common Software: frequently used LOFAR libraries
LCU/ Local Controller Unit: station software tools
MAC/ Monitoring and Control software, static metadata
README This file
RTCP/ Real-Time Central Processing: correlator and beamformer
SAS/ Submission And Scheduling
SubSystems/ Build targets for deployment and some integration tests
getTreeList is extended with the four new fields. Every field is optional.
The new function is:
// getTreeList ([treeType], [classification], [groupID], [processType], [processSubtype], [strategy])
vector<OTDBtree> getTreeList(treeType, classifType, uint32, const string&, const string&, const string&);
Contact Information
-------------------
setMomInfo is extenden with the groupID:
The new function is:
bool setMomInfo(treeIDType, treeIDType, uint32, string)
// setMomInfo (treeID, MomID, groupID, campaign)
For questions about LOFAR software installation, usage, or bug reports, please contact the ASTRON Radio Observatory software team via:
softwaresupport AT astron DOT nl
The GroupID's are managed by OTDB, so a new function is added to the database to get a new unique groupID:
uint32 newGroupID();
For questions about observing with LOFAR or your data product, please contact ASTRON Science Support via:
NOTES NOTES NOTES NOTES NOTES
Since it is not clear yet what values are allowed in the processType, processSubtype and strategy fields
there is no check on the values of the fields yet other than that the combination of them must be unique
for default templates.
The processType fields can only be assigned to template and default-template trees. Trying to assign them
to the other fieldtypes results in an error.
sciencesupport AT astron DOT nl
This diff is collapsed.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment