Skip to content

Latest commit

 

History

History
97 lines (78 loc) · 3.66 KB

README.md

File metadata and controls

97 lines (78 loc) · 3.66 KB
Raw

Commander3 postprocessing tool (c3pp)

A python code for processing and plotting commander3 files.

Temperature Polarization
Masterpiece Masterpiece
Thermal dust Synchrotron
Masterpiece Masterpiece
Spinning dust Free-free
Masterpiece Masterpiece

Installation

Install tools by running

pip install git+https://github.com/Cosmoglobe/c3pp.git -U

or

pip install git+https://github.com/Cosmoglobe/c3pp.git --user

and make sure that

PATH=$PATH:~/.local/bin

is in your path.

Usage

The tool uses command line arguments and has many different tools built in (and more coming). In order to get an overview of the available tools and how to access them, simply type

c3pp --help

in your terminal. This will display a list of all available tools. For more information on each specific tool, simply type

c3pp [toolname] --help

and a description will be printed:

[command prompt]$ c3pp
Usage: c3pp [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
  alm2fits          Converts c3 alms in .h5 file to fits.
  crosspec          Calculates a powerspectrum from polspice.
  dlbin2dat         Outputs binned powerspectra averaged over a range of output samples.
  fits-mean         Calculates the mean over sample range from fits-files.
  fits-stddev       Calculates the standard deviation over sample range from fits-files.
  generate-sky      Generate sky maps from separate input maps.
  gnomplot          Gnomonic view plotting.
  h52fits           Outputs a .h5 map to fits on the form 000001_cmb_amp_n1024.fits
  make-diff-plots   Produces difference maps between output directories.
  mean              Calculates the mean over sample range from .h5 file.
  output-sky-model  Outputs spectrum plots.
  pixreg2trace      Outputs the values of the pixel regions for each sample to a dat file.
  plot              Plots map from .fits or h5 file.
  plotrelease       Plots all release files.
  printdata         Prints the data of a fits file
  printheader       Prints the header of a fits file.
  qu2ang            Calculates polarization angle map from QU signals.
  release           Creates a release file-set on the BeyondPlanck format.
  rmcolumn          Removes columns in fits file
  sigma-l2fits      Converts c3-h5 dataset to fits for c1 BR and GBR estimator analysis.
  specplot          Plots the file output by the Crosspec function.
  stddev            Calculates the stddev over sample range from .h5 file.
  traceplot         Traceplot of samples from .dat.

Contributing

Pull requests are welcome! For feature requests open an issue.

Funding

This work has received funding from the European Union's Horizon 2020 research and innovation programme under grant agreements No 776282 (COMPET-4; BeyondPlanck), 772253 (ERC; bits2cosmology) and 819478 (ERC; Cosmoglobe).

License

MIT