LOFAR Local Sky Model Tool
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
docs
lsmtool
parsets
tests
.gitignore
LICENSE
MANIFEST.in
README.md
setup.cfg
setup.py
tox.ini

README.md

LSMTool: the LOFAR Sky Model Tool

LSMTool allows the manipulation of LOFAR sky models (in the makesourcedb format).

Author:

  • David Rafferty

Based on contributed scripts from:

  • Björn Adebahr
  • Francesco de Gasperin
  • Reinout van Weeren

Contents:

  • docs/: documentation
  • tests/: contains test sky models and scripts useful for validation
  • bin/: contains lsmtool executable
  • lsmtool/: contains the main LSMTool scripts
  • lsmtool/operations/: contains the modules for operations
  • parsets/: some example parsets

The following operations are available:

  • SELECT: Select sources by source or patch properties
  • REMOVE: Remove sources by source or patch properties
  • TRANSFER: Transfer a patch scheme from one sky model to another
  • GROUP: Group sources into patches
  • UNGROUP: Remove patches
  • MOVE: Move a source or patch position
  • MERGE: Merge two or more patches into one
  • CONCATENATE: Concatenate two sky models
  • ADD: Add a source
  • SETPATCHPOSITIONS: Calculate and set patch positions
  • PLOT: Plot the sky model
  • COMPARE: Compare source fluxes and positions of two sky models

For details, please see the full documentation.

Installation

LSMTool is already installed on the LOFAR CEP3 cluster. Users on CEP3 should run the following commands before using LSMTool:

source ~rafferty/init_lsmtool

If you want to install LSMTool yourself, follow the instructions below.

Dependencies

Downloading and Installing

Get the latest developer version by cloning the git repository:

git clone https://github.com/darafferty/LSMTool.git

Then install with:

cd LSMTool
python setup.py install

Testing

You can test that the installation worked with:

python setup.py test

If no errors occur, LSMTool is installed correctly.

Usage

The LSMTool executable can be used from the command line with a parset that defines the steps to be done. E.g.:

$ lsmtool model.sky lsmtool.parset

The parset follows the usual NDPPP/BBS format. E.g.:

# Select individual sources with Stokes I fluxes above 1 Jy
LSMTool.Steps.select.Operation = SELECT
LSMTool.Steps.select.FilterExpression = I > 1.0 Jy
LSMTool.Steps.select.OutFile = out_model.sky

LSMTool can also be used in Python scripts by importing the lsmtool module. E.g.:

>>> import lsmtool
>>> skymod = lsmtool.load('model.sky')
>>> skymod.select('I > 1.0 Jy')
>>> skymod.write('out_model.sky')

For further details, please see the full documentation.