Metadata-Version: 2.4
Name: edges-analysis
Version: 8.2.1
Summary: Functionality for processing EDGES field data
Author-email: Steven Murray <steven.murray@sns.it>, Nivedita Mahesh <nmahesh4@asu.edu>, Akshatha Vydula <avydula@asu.edu>
License: MIT
Project-URL: Documentation, https://edges-analysis.readthedocs.io/en/latest/
Project-URL: Repository, https://github.com/edges-collab/edges-analysis
Project-URL: Issues, https://github.com/edges-collab/edges-analysis/issues
Project-URL: Changelog, https://github.com/edges-collab/edges-analysis/releases
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: Implementation :: CPython
Requires-Python: >=3.11
Description-Content-Type: text/x-rst
License-File: LICENSE.txt
License-File: AUTHORS.rst
Requires-Dist: numpy>=2.0
Requires-Dist: scipy>=1.16
Requires-Dist: matplotlib
Requires-Dist: astropy>=5.0
Requires-Dist: pygsdata>=0.2.2
Requires-Dist: astropy-healpix
Requires-Dist: h5py
Requires-Dist: tqdm
Requires-Dist: rich>=9.0
Requires-Dist: pathos
Requires-Dist: methodtools
Requires-Dist: attrs
Requires-Dist: questionary
Requires-Dist: psutil
Requires-Dist: jinja2
Requires-Dist: astropy-healpix
Requires-Dist: typing_extensions
Requires-Dist: frozendict
Requires-Dist: jupyter_core
Requires-Dist: read-acq
Requires-Dist: bidict
Requires-Dist: pyyaml
Requires-Dist: dill
Requires-Dist: hickle
Requires-Dist: hickleable>=0.2.4
Requires-Dist: statsmodels
Requires-Dist: cattrs
Requires-Dist: cyclopts
Requires-Dist: yabf
Requires-Dist: pooch
Requires-Dist: py7zr
Requires-Dist: deprecation
Provides-Extra: testing
Requires-Dist: pytest; extra == "testing"
Requires-Dist: pytest-cov; extra == "testing"
Requires-Dist: pytest_cases>=3.8.3; extra == "testing"
Provides-Extra: docs
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: nbsphinx; extra == "docs"
Requires-Dist: numpydoc; extra == "docs"
Requires-Dist: sphinx_rtd_theme; extra == "docs"
Requires-Dist: sphinx_click; extra == "docs"
Requires-Dist: ipython; extra == "docs"
Requires-Dist: myst-parser; extra == "docs"
Requires-Dist: furo; extra == "docs"
Provides-Extra: report
Requires-Dist: papermill; extra == "report"
Requires-Dist: jupyter; extra == "report"
Requires-Dist: beautifultable; extra == "report"
Provides-Extra: all
Requires-Dist: edges-analysis[report]; extra == "all"
Provides-Extra: dev
Requires-Dist: edges-analysis[docs,report,testing]; extra == "dev"
Requires-Dist: pre-commit; extra == "dev"
Dynamic: license-file

==============
edges-analysis
==============

.. image:: https://github.com/edges-collab/edges-analysis/actions/workflows/test_suite.yaml/badge.svg
  :target: https://github.com/edges-collab/edges-analysis/actions/workflows/test_suite.yaml
.. image:: https://readthedocs.org/projects/edges-analysis/badge/?version=stable
  :target: https://edges-analysis.readthedocs.io/en/stable/?badge=stable
.. image:: https://codecov.io/gh/edges-collab/edges-analysis/branch/master/graph/badge.svg
  :target: https://codecov.io/gh/edges-collab/edges-analysis
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
  :target: https://github.com/psf/black

**Analysis and Calibration Code for the EDGES experiment**

``edges-analysis`` has methods for I/O, receiver calibration, averaging, filtering and
calibrating EDGES (and other global 21cm experiment) data. The primary goal of the code
is to allow the analysis to be fully reproducible, efficient, and clear.

Features
========

``edges-analysis`` includes the following features:

* Methods for reading/writiing EDGES-specific datasets/data products.
* A full set of methods for receiver calibration, applicable to *most*
  current global 21cm experiments (based on Dicke-switch calibration +
  the noise-wave formalism).
* Many algorithms/routines for flagging bad data, including RFI, outliers
  in time/frequency, poor auxiliary data etc.
* A full-featured interface for linear modelling and fitting.
* Algorithms for consistent averaging of data over nights/times/frequencies,
  either in specified bins or complete averaging of the dataset.
* Works with ``pygsdata`` objects for a consistent interface all the way through
  an analysis pipeline, including maintenance of metadata about the operations
  applied to particular data (and propagation of metadata like the number
  of averaged samples).
* Simulation algorithms, including beam models and sky models.

Documentation
=============

Documentation is hosted on `ReadTheDocs <https://edges-analysis.readthedocs.org>`_.


Installation
============

This package can be installed with ``pip``::

   pip install edges-analysis

If you want all the extras (for development etc), use the ``[dev]`` extra, like so::

  pip install edges-analysis[dev]


You can also install directly from github. Either cloning first::

    git clone https://github.com/edges-collab/edges-analysis
    cd edges-analysis
    pip install [-e] .

or directly::

    pip install git+git://github.com/edges-collab/edges-analysis.git
