Metadata-Version: 2.4
Name: bettermoments
Version: 1.11.0
Summary: Robust moment map making.
Author: Daniel Foreman-Mackey
Author-email: Richard Teague <rteague@mit.edu>
License: MIT
Project-URL: Homepage, https://github.com/PlanetFormationLab/bettermoments
Project-URL: Documentation, https://bettermoments.readthedocs.io
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: numpy>=2.0
Requires-Dist: scipy
Requires-Dist: astropy
Requires-Dist: tqdm
Requires-Dist: emcee>=3
Requires-Dist: zeus-mcmc
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Dynamic: license-file

# bettermoments

<p align='center'>
  <br/>
  <img src="https://github.com/PlanetFormationLab/bettermoments/blob/master/docs/_static/TWHya.png" width="435" height="435"><br/>
  <br>
  Measuring precise line-of-sight velocities from Doppler shifted lines is essential<br/>
  when looking for small scale deviations indicative of, for example, embedded planets.<br/>Do that with <b>bettermoments</b>.
  <br><br>
  <a href="https://doi.org/10.5281/zenodo.1419754"><img src="https://zenodo.org/badge/DOI/10.5281/zenodo.1419754.svg" alt="DOI"></a>
  <a href="http://ascl.net/1901.009"><img src="https://img.shields.io/badge/ascl-1901.009-blue.svg?colorB=262255" alt="ascl:1901.009" /></a>
  <a href='https://bettermoments.readthedocs.io/en/latest/?badge=latest'>
      <img src='https://readthedocs.org/projects/bettermoments/badge/?version=latest' alt='Documentation Status' />
  </a>
  <br><br><br><br>
</p>


## Installation

To install, we recommend using pip:

```bash
pip install bettermoments
```

## Usage

The easiest way to interface with ``bettermoments`` is through the command line. To use the default quadratic method simply use,

```bash
bettermoments path/to/cube.fits
```

while various other methods, discussed further in the documentation, can be accessed via the ``-method`` flag:

```bash
bettermoments path/to/cube.fits -method zeroth
```

Since v1.10.0, ``bettermoments`` can also account for spectrally correlated noise (e.g. from Hanning smoothing) when calculating uncertainties. Add the ``--acf`` flag to estimate the noise autocorrelation function from off-source pixels and propagate it through the full spectral covariance:

```bash
bettermoments path/to/cube.fits -method zeroth --acf
```

A quick

```bash
bettermoments --help
```

will give a quick overview of what options there are.

## Documentation

More information can be found in the [documentation](https://bettermoments.readthedocs.io/en/latest/?badge=latest).
