Skip to main content

nikamap: a package to manipulate data produced by the IDL NIKA2 pipeline

Project description

Latest Version License Wheels Format pyversions Read the doc

nikamap is a Python package built around ContMap, a general-purpose class for processing and analysing continuum maps from radio/millimetre observatories. It provides beam handling, match-filtering, point-source detection and photometry, and cutout / simultaneous stacking.

For NIKA2 users, nikamap offers first-class support for the FITS data products of both the IDL and PIIC NIKA2 reduction pipelines through NikaMap and NikaFits, thin subclasses of ContMap that handle multi-band files and scan-level jackknife realisations.

Quick start with generic continuum data

from nikamap import ContMap

cm = ContMap.read('mymap.fits')
cm.plot()

Quick start with NIKA2 data

from nikamap import NikaMap

nm = NikaMap.read('map.fits', band='1mm')
nm.plot()

or using the multi-band container:

from nikamap import NikaFits

data = NikaFits.read('map.fits')
data['1mm'].plot()

Read the documentation on readthedoc.

Features

  • reading, slicing, plotting

  • match filtering, point source detection and photometry

  • powspec spectra estimation

  • bootstraping and jackknife

Requirements

You need python 3.10 or later to run nikamap. You will also need numpy, scipy, matplotlib, astropy>=2.0 and photutils>=1.13. The master branch is based on newert photutils API>=1.8, while the tag:0.6 branch follow the old API and python up to 3.8

Installation

nikamap can be installed with

pip install nikamap

But if you prefer to work on the master branch, you can clone the git repository, and install it

git clone https://gitlab.lam.fr/N2CLS/nikamap.git
cd nikamap
pip install -e .

or directly install it from git

pip install git+https://gitlab.lam.fr/N2CLS/nikamap.git

License

This project is licensed under the MIT license.

Travis Master Build AppVeoyr Maintainability Code Health SonarQube

Contributing

See CONTRIBUTING.rst for the development setup, test commands, documentation build, and contribution expectations.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nikamap-1.3.tar.gz (8.0 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nikamap-1.3-py2.py3-none-any.whl (664.7 kB view details)

Uploaded Python 2Python 3

File details

Details for the file nikamap-1.3.tar.gz.

File metadata

  • Download URL: nikamap-1.3.tar.gz
  • Upload date:
  • Size: 8.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for nikamap-1.3.tar.gz
Algorithm Hash digest
SHA256 45f89a16d77cb7024dccae92dfc8a0f0efbe1712c0d08b92b4a36784ce289a41
MD5 c685a6e445e3a88b9eb07f0fdee5abfc
BLAKE2b-256 89f45a30c38f29955bdfd4647353a0212353a32ac80c6082a07337fbb3ec73a5

See more details on using hashes here.

File details

Details for the file nikamap-1.3-py2.py3-none-any.whl.

File metadata

  • Download URL: nikamap-1.3-py2.py3-none-any.whl
  • Upload date:
  • Size: 664.7 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for nikamap-1.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 0d7339c07a0d8cb5090496c685b1ed8a5d635cc4dbf8e22fdc957dfa29975dc0
MD5 9e4502956bf48fa6c45906e7e859401a
BLAKE2b-256 0526f2143ccb8851ebea775a503c7f538b01dadffe8b9f8127a44c2ddb64036c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page