Metadata-Version: 2.1
Name: vis-cpu
Version: 1.1.0
Summary: Fast visibility simulator with interface to CPU and GPU
Home-page: https://github.com/hera-team/vis_cpu
Author: HERA-Team
Author-email: steven.g.murray@asu.edu
License: MIT
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.9
Description-Content-Type: text/x-rst
License-File: LICENSE.txt
Requires-Dist: astropy
Requires-Dist: numpy
Requires-Dist: psutil
Requires-Dist: pyuvdata (>=2.2.8)
Requires-Dist: scipy
Provides-Extra: all
Requires-Dist: vis-cpu[dev,gpu,profile] ; extra == 'all'
Provides-Extra: dev
Requires-Dist: vis-cpu[docs,test] ; extra == 'dev'
Provides-Extra: docs
Requires-Dist: furo ; extra == 'docs'
Requires-Dist: ipython ; extra == 'docs'
Requires-Dist: nbsphinx ; extra == 'docs'
Requires-Dist: numpydoc ; extra == 'docs'
Requires-Dist: sphinx ; extra == 'docs'
Provides-Extra: gpu
Requires-Dist: jinja2 ; extra == 'gpu'
Requires-Dist: pycuda ; extra == 'gpu'
Requires-Dist: scikit-cuda ; extra == 'gpu'
Provides-Extra: profile
Requires-Dist: click ; extra == 'profile'
Requires-Dist: line-profiler ; extra == 'profile'
Requires-Dist: pyuvsim (>=1.2.5) ; extra == 'profile'
Provides-Extra: test
Requires-Dist: hypothesis ; extra == 'test'
Requires-Dist: ipython ; extra == 'test'
Requires-Dist: matplotlib ; extra == 'test'
Requires-Dist: pyradiosky ; extra == 'test'
Requires-Dist: pytest ; extra == 'test'
Requires-Dist: pytest-cov ; extra == 'test'
Requires-Dist: pyuvsim[sim] (>=1.2.5) ; extra == 'test'

=======
vis_cpu
=======
.. image:: https://github.com/hera-team/vis_cpu/workflows/Tests/badge.svg
    :target: https://github.com/hera-team/vis_cpu
.. image:: https://badge.fury.io/py/vis-cpu.svg
    :target: https://badge.fury.io/py/vis-cpu
.. image:: https://codecov.io/gh/hera-team/vis_cpu/branch/main/graph/badge.svg
    :target: https://codecov.io/gh/hera-team/vis_cpu
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black


Fast visibility simulator capable of running on CPU and GPU.


Description
===========

``vis_cpu`` is a Python/numpy-based simulator for interferometer visibilities.
It models the sky as an ensemble of point sources, each with their own frequency
spectrum. Diffuse emission can be modelled by treating (e.g.) each pixel of a Healpix
map as a separate source. The code is capable of modelling polarized visibilities
and primary beams, but currently only a Stokes I sky model.

``vis_cpu`` includes a separate ``pycuda``-based implementation called ``vis_gpu``.
This is intended to keep feature parity with the ``vis_cpu`` code to the greatest
extent possible.

An example wrapper for the main ``vis_cpu`` simulator function is provided in this
package (``vis_cpu.wrapper.simulate_vis()``).

Installation
============
Merely do ``pip install vis_cpu``. If you want to use the GPU functions, install
with ``pip install vis_cpu[gpu]``.

Developers
==========
Run ``pre-commit install`` before working on this code.

Read the Docs
=============
https://vis-cpu.readthedocs.io/en/latest/
