Skip to content

Commit 2894119

Browse files
committed
Updated index page and removed redundant introduction page
1 parent 7a5d723 commit 2894119

2 files changed

Lines changed: 41 additions & 70 deletions

File tree

docs/index.rst

Lines changed: 41 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,51 @@
1+
.. image:: https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12-blue
2+
:target: https://www.python.org/downloads/release/python-3120
3+
4+
.. image:: https://github.com/casangi/astrohack/actions/workflows/python-testing-linux.yml/badge.svg
5+
6+
.. image:: https://github.com/casangi/astrohack/actions/workflows/pythonpublish.yml/badge.svg
7+
:target:
8+
9+
10+
.. image:: https://readthedocs.org/projects/astrohack/badge/?version=stable
11+
:target: https://astrohack.readthedocs.io/en/stable/?badge=stable
12+
13+
114
Holography Antenna Commissioning Kit
215
====================================
316

4-
.. image:: _media/astrohack_logo.png
17+
.. image:: https://github.com/casangi/astrohack/blob/astrohack-dev/docs/_media/astrohack_logo.png
518
:width: 250px
619
:align: left
720

21+
AstroHACK (Holography and Antenna Comissioning Kit) is a python
22+
package intended for NRAO telescope support activities, such as
23+
holography and antenna position corrections.
24+
25+
Currently AstroHACK supports:
26+
27+
- `Astronomical holographies from the VLA <./tutorial_vla.html>`_.
28+
- Astronomical holographies from ALMA.
29+
- `Antenna position corrections for the VLA <./locit_tutorial>`_.
30+
- `Near-field ALMA holographies <./AstroHACK-for-NF-ALMA.html>`_ have
31+
basic support, such as the creation of Aperture images, but the
32+
correction of near-field effects is not yet supported.
33+
34+
In the near term we are working to support the `ngVLA antenna
35+
prototype <https://public.nrao.edu/ngvla/>`_ comissioning activities.
36+
The prototype antenna is currently (March 2025) under construction at
37+
the VLA site.
38+
39+
The holography tasks in AstroHACK port much of the functionality of
40+
AIPS holography tasks (UVHOL, HOLOG and PANEL) to a python framework
41+
that enables us to take advantage of modern parallelization and code
42+
acceleration technologies, such as `Dask <https://www.dask.org/>`_ and
43+
`Numba <https://numba.pydata.org/>`_. Making the reduction of
44+
holography data much faster and streamlined for the user.
845

9-
(Holography Antenna Commissioning Kit) is a Python package that produces antenna aperture images and panel adjustment corrections from calibrated holography measurement sets. Initially, it will support holography data from the VLA and ALMA, with the future goal of supporting the ngVLA. Much of the core functionality from the following AIPS tasks has been ported: UVHOL, HOLOG, and PANEL. astroHack enables parallel execution by using Dask and efficient single-threaded performance by making use of Numba.
1046

11-
> 📝 astroHACK is under active development! Breaking API changes are still happening on a regular basis, so proceed with caution.
47+
> 📝 astroHACK is under active development! Breaking API changes are
48+
still happening on a regular basis, so proceed with caution.
1249

1350
.. toctree::
1451
:hidden:
@@ -21,3 +58,4 @@ Holography Antenna Commissioning Kit
2158
locit_tutorial
2259
cassegrain_ray_tracing_tutorial
2360
AstroHACK_under_a_venv_for_locit
61+
AstroHACK-for-NF-ALMA

docs/introduction.ipynb

Lines changed: 0 additions & 67 deletions
This file was deleted.

0 commit comments

Comments
 (0)