Package: pyradiosky
pyradioskyPython objects and interfaces for representing diffuse, extended and compact
astrophysical radio sources.pyradiosky is currently in a very early development stage, interfaces are changing rapidly.The primary user class isSkyModel, which supports:catalogs of point sources (read/write to hd5 and text files, read VOTables)diffuse models as HEALPix maps (read/write to hd5 files)conversion between RA/Dec and Azimuth/Elevation including calculating full
polarization coherencies in Az/El.File formatspyradiosky supports reading in catalogs from several formats, including VO Table files,
text files,FHDcatalog files and SkyH5 files and
supports writing to SkyH5 and text files. SkyH5 is an HDF5-based file format defined by
the pyradiosky team, a full description is in theSkyH5 memo.Community GuidelinesContributions to this package to add new file formats or address any of the
issues in theissue logare very welcome, as are bug reports and feature requests.
Please see ourguide on contributingVersioningWe use ageneration.major.minorversion number format. We use thegenerationnumber for very significant improvements or major rewrites, themajornumber
to indicate substantial package changes (intended to be released every ~6 months)
and theminornumber to release smaller incremental updates (intended to be
released approximately monthly and which usually do not include breaking API
changes). We do our best to provide a significant period (usually 2 major
generations) of deprecation warnings for all breaking changes to the API.
We track all changes in ourchangelog.DocumentationDeveloper API documentation is hostedhere.InstallationSimple installation via pip is available for users, developers should follow
the directions underDeveloper Installationbelow.For simple installation, the latest stable version is available via pip withpip install pyradiosky.There are some optional dependencies that are required for specific functionality,
which will not be installed automatically by pip.
SeeDependenciesfor details on installing optional dependencies.DependenciesIf you are usingcondato manage your environment, you may wish to install the
following packages before installingpyradiosky:Required:astropy>=5.2h5py>=3.1numpy>=1.20scipy>=1.5pyuvdata>=2.4.1setuptools_scm>=7.0.3Optional:astropy-healpix>=0.6 (for working with beams in HEALPix formats)astroquery>=0.4.4 (for downloading GLEAM and other VizieR catalogs)lunarsky>=0.2.1 (for supporting telescope locations on the moon)We suggest using conda to install all the dependencies. To install
pyuvdata, astropy-healpix and astroquery, you'll need to add conda-forge as a channel
(conda config --add channels conda-forge).If you do not want to use conda, the packages are also available on PyPI.
You can install the optional dependencies via pip by specifying an option
when you install pyradiosky, as inpip install .[healpix]which will install all the required packages for using the HEALPix functionality
in pyradiosky. The options that can be passed in this way are:
[healpix,astroquery,lunarsky,all,doc,test,dev].
The first three (healpix,astroquery,lunarsky) enable various specific
functionality whileallwill install all optional dependencies.
The last three (doc,testanddev) may be useful for developers of pyradiosky.Developer InstallationClone the repository usinggit clone https://github.com/RadioAstronomySoftwareGroup/pyradiosky.gitNavigate into the pyradiosky directory and runpip install .(note thatpython setup.py installdoes not work).
Note that this will attempt to automatically install any missing dependencies.
If you use anaconda or another package manager you might prefer to first install
the dependencies as described inDependencies.To install without dependencies, runpip install --no-depsIf you want to do development on pyradiosky, in addition to the other dependencies
you will need the following packages:pytestpytest-covcoveragepre-commitsphinxpypandocOne way to ensure you have all the needed packages is to use the includedenvironment.yamlfile to create a new environment that will
contain all the optional dependencies along with dependencies required for
testing and development (conda env create -f environment.yml).
Alternatively, you can specifydevwhen installing pyradiosky
(as inpip install pyradiosky[dev]) to install the packages needed for testing
and documentation development.To use pre-commit to prevent committing code that does not follow our style,
you'll need to runpre-commit installin the top levelpyradioskydirectory.TestsUses thepytestpackage to execute test suite.
From the source pyradiosky directory runpytestorpython -m pytest.Maintainerspyradiosky is maintained by the RASG Managers, which currently include:Adam Beardsley (Arizona State University)Bryna Hazelton (University of Washington)Daniel Jacobs (Arizona State University)Paul La Plante (University of California, Berkeley)Jonathan Pober (Brown University)Please use the channels discussed in theguide on contributingfor code-related discussions. You can contact us privately if needed atrasgmanagers@gmail.com.AcknowledgmentsSupport for pyradiosky was provided by NSF awards #1835421 and #1835120.