Getting started#
This documentation walks you through the installation and usage. It is best to try out the examples as you read, because they illustrate how Nway works.
Code boxes indicate text about the illustrative examples and their explanations.
Useful explanation for users on how to prepare files or how to run Nway are found in blue boxes.
Sometimes there are commands you can copy-paste.
start by installing nway. Do not forget to download the example data files so you can follow the tutorial!
Learn basic to advanced use in the User guide: Matching catalogs.
Questions, missing documentation, bugs? Learn how to start contributing.
Get different results in different version? Check what changed in the release history.
Want to use Python API instead of the command line? API reference
If you are interested in the rigorous background, head to mathematical details.
Terminology#
Source#
A detection in a certain wavelength significant enough to be recorded in a catalogue with sky position.
Counterpart#
The corresponding source in another catalogue.
Association#
A specific combination of entries from the various catalogues, i.e. a tuple of detections associated with each other.
Match#
Same as association, used interchangeably.
Object#
A physical entity in the real universe, emitting radiation.