xradio 0.0.28__py3-none-any.whl → 0.0.30__py3-none-any.whl

xradio/vis/vis_io.py

@@ -15,7 +15,8 @@ def read_vis(
     chunks: Union[Tuple[int], List[int]] = None,
     expand: bool = False,
 ) -> CASAVisSet:
-    """Read a MeasurementSet (MSv2 format) into a next generation CASA
+    """
+    Read a MeasurementSet (MSv2 format) into a next generation CASA
     dataset (visibilities dataset as a set of Xarray datasets).
 
     The MS is partitioned into multiple sub- Xarray datasets (where the data variables are read as
@@ -24,31 +25,37 @@ def read_vis(
     and polarizations) and, subject to experimentation, by scan and subscan. This results in multiple
     partitions as xarray datasets (xds) contained within a main xds (mxds).
 
-    :param infile: Input MS filename
-    :param rowmap: (to be removed) Dictionary of DDI to tuple of (row indices, channel indices). Returned
-    by ms_selection function. Default None ignores selections
-    :param subtables: Also read and include subtables along with main table selection. Default False will
-    omit subtables (faster)
-    :param asdm_subtables: in addition to MeasurementSet subtables (if enabled), also read extension
-    subtables names "ASDM_*"
-    :param partition_scheme: (experimenting) Whether to partition sub-xds datasets by scan/subscan
-    (in addition to DDI), or other alternative partitioning schemes. Accepted values: 'scan/subscan',
-    'scan', 'ddi', 'intent'. Default: 'intent'
-    :param chunks: Can be used to set a specific chunk shape (with a tuple of ints), or to control the
-    optimization used for automatic chunking (with a list of ints). A tuple of ints in the form of (row,
-    chan, pol) will use a fixed chunk shape. A list or numpy array of ints in the form of [idx1, etc]
-    will trigger auto-chunking optimized for the given indices, with row=0, chan=1, pol=2. Default None
-    uses auto-chunking with a best fit across all dimensions (probably sub-optimal for most cases).
-    :param expand: (to be removed) Whether or not to return the original flat row structure of the MS (False)
-    or expand the rows to time x baseline dimensions (True). Expanding the rows allows for easier indexing
-    and parallelization across time and baseline dimensions, at the cost of some conversion time. Default
-    False
-    :param **kwargs: (to be removed?) Selection parameters from the standard way of making CASA MS
-    selections. Supported keys are: spw, field, scan, baseline, time, scanintent, uvdist, polarization,
-    array, observation.  Values are strings.
-
-    :return: ngCASA visisbilities dataset, essentially made of two dictionaries of
-    metainformation and data partitions
+    Parameters
+    ----------
+    infile : str
+        Input MS filename
+    subtables : bool (Default value = True)
+        Also read and include subtables along with main table selection. Default False will
+        omit subtables (faster)
+    asdm_subtables : bool (Default value = True)
+        in addition to MeasurementSet subtables (if enabled), also read extension
+        subtables names "ASDM_*"
+    partition_scheme : str (Default value = "intent")
+        (experimenting) Whether to partition sub-xds datasets by scan/subscan
+        (in addition to DDI), or other alternative partitioning schemes. Accepted values: 'scan/subscan',
+        'scan', 'ddi', 'intent'. Default: 'intent'
+    chunks : Union[Tuple[int], List[int]] (Default value = None)
+        Can be used to set a specific chunk shape (with a tuple of ints), or to control the
+        optimization used for automatic chunking (with a list of ints). A tuple of ints in the form of (row,
+        chan, pol) will use a fixed chunk shape. A list or numpy array of ints in the form of [idx1, etc]
+        will trigger auto-chunking optimized for the given indices, with row=0, chan=1, pol=2. Default None
+        uses auto-chunking with a best fit across all dimensions (probably sub-optimal for most cases).
+    expand : bool (Default value = False)
+        (to be removed) Whether or not to return the original flat row structure of the MS (False)
+        or expand the rows to time x baseline dimensions (True). Expanding the rows allows for easier indexing
+        and parallelization across time and baseline dimensions, at the cost of some conversion time. Default
+        False
+
+    Returns
+    -------
+    CASAVisSet
+        ngCASA visisbilities dataset, essentially made of two dictionaries of
+        metainformation and data partitions
     """
     infile = os.path.expanduser(infile)
     if not os.path.isdir(infile):
@@ -68,16 +75,28 @@ def load_vis_block(
     partition_key: Tuple[int, int, str],
     subtables: List[str] = None,
 ) -> Dict[Tuple[int, int], xr.Dataset]:
-    """Read a chunk of a visibilities dataset into an Xarray dataset, loading the
+    """
+    Read a chunk of a visibilities dataset into an Xarray dataset, loading the
     data in memory.
     The input format support is the MeasurementSet v2 (MSv2 format)
 
-    :param infile: Input visibilities path
-    :param block_des: specification of chunk to load
-
-    :return: CASA visibilities dataset holding a chunk of visibility data, for one
-    partition
-    (spw_id, pol_setup_id, intent_string triplet)
+    Parameters
+    ----------
+    infile : str
+        Input visibilities path
+    block_des : Dict[str, slice]
+        specification of chunk to load
+    partition_key: Tuple[int, int, str]
+        key of partition to load
+    subtables: List[str] (Default value = None)
+        subtables to load
+
+    Returns
+    -------
+    Dict[Tuple[int, int], xr.Dataset]
+        CASA visibilities dataset holding a chunk of visibility data, for one
+        partition
+        (spw_id, pol_setup_id, intent_string triplet)
     """
     # TODO: use the input partition_key
     # the intent str of the partition_key is not yet effectively used
@@ -92,20 +111,33 @@ def write_vis(
     compressor: Union[numcodecs.abc.Codec, None] = None,
     out_format: str = "zarr",
 ) -> None:
-    """Write CASA vis dataset to disk.
+    """
+    Write CASA vis dataset to disk.
     The disk format supported is "zarr". When chunks_on_disk is not specified the
     chunking in the input dataset is used. When chunks_on_disk is specified that
     dataset is saved using that chunking.
 
-    :param cds: CASA visibilities dataset to write to disk
-    :param outpath: output path, generally ends in .zarr
-    :param chunks_on_disk: a dictionary with the chunk size that will
-    be used when writing to disk. For example {'time': 20, 'chan': 6}.
-    If chunks_on_disk is not specified the chunking of dataset will
-    be used.
-    :param compressor: the blosc compressor to use when saving the
-    converted data to disk using zarr. If None the zstd compression
-    algorithm used with compression level 2.
+    Parameters
+    ----------
+    cds : CASAVisSet
+        CASA visibilities dataset to write to disk
+    outpath : str
+        output path, generally ends in .zarr
+    chunks_on_disk : Union[Dict, None] (Default value = None)
+        a dictionary with the chunk size that will
+        be used when writing to disk. For example {'time': 20, 'chan': 6}.
+        If chunks_on_disk is not specified the chunking of dataset will
+        be used.
+    compressor : Union[numcodecs.abc.Codec, None] (Default value = None)
+        the blosc compressor to use when saving the
+        converted data to disk using zarr. If None the zstd compression
+        algorithm used with compression level 2.
+    out_format : str (Default value = "zarr")
+        format to write
+
+    Returns
+    -------
+    None
     """
 
     if out_format == "zarr":

{xradio-0.0.28.dist-info → xradio-0.0.30.dist-info}/LICENSE.txt

@@ -1,6 +1,11 @@
 BSD 3-Clause License
 
-Copyright (c) 2023, Associated Universities, Inc.
+All works in this repository are copyrighted 2024.  
+For inquiries contact  Associated Universities, Inc., 2650 Park Tower Drive Vienna, VA 22180, USA.
+
+Portions of this repository are copyrighted by the following entities:
+1. AUI/NRAO, ESO, NAOJ, in the framework of the ALMA partnership.
+2. AUI/NRAO in the framework of the ngVLA project.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:

{xradio-0.0.28.dist-info → xradio-0.0.30.dist-info}/METADATA

@@ -1,11 +1,16 @@
 Metadata-Version: 2.1
 Name: xradio
-Version: 0.0.28
+Version: 0.0.30
 Summary: Xarray Radio Astronomy Data IO
 Author-email: Jan-Willem Steeb <jsteeb@nrao.edu>
 License: BSD 3-Clause License
         
-        Copyright (c) 2023, Associated Universities, Inc.
+        All works in this repository are copyrighted 2024.  
+        For inquiries contact  Associated Universities, Inc., 2650 Park Tower Drive Vienna, VA 22180, USA.
+        
+        Portions of this repository are copyrighted by the following entities:
+        1. AUI/NRAO, ESO, NAOJ, in the framework of the ALMA partnership.
+        2. AUI/NRAO in the framework of the ngVLA project.
         
         Redistribution and use in source and binary forms, with or without
         modification, are permitted provided that the following conditions are met:
@@ -42,7 +47,7 @@ Requires-Dist: distributed
 Requires-Dist: graphviper
 Requires-Dist: matplotlib
 Requires-Dist: numba >=0.57.0
-Requires-Dist: numpy
+Requires-Dist: numpy <2.0.0
 Requires-Dist: prettytable
 Requires-Dist: pytest
 Requires-Dist: pytest-cov
@@ -52,12 +57,12 @@ Requires-Dist: scipy
 Requires-Dist: tqdm
 Requires-Dist: xarray
 Requires-Dist: zarr
-Requires-Dist: bokeh
-Requires-Dist: jupyterlab
 Requires-Dist: pyarrow
+Requires-Dist: typeguard
 Requires-Dist: typing-extensions ; python_version < "3.10"
 Requires-Dist: python-casacore >=3.5.2 ; sys_platform != "darwin"
 Provides-Extra: docs
+Requires-Dist: jupyterlab ; extra == 'docs'
 Requires-Dist: ipykernel ; extra == 'docs'
 Requires-Dist: ipympl ; extra == 'docs'
 Requires-Dist: ipython ; extra == 'docs'

xradio-0.0.30.dist-info/RECORD

@@ -0,0 +1,73 @@
+xradio/__init__.py,sha256=atgBiCKe3d2v5UbVOtFD5sGXblX09MZg44dOH3Ceajo,363
+xradio/_utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+xradio/_utils/array.py,sha256=DgSLenRDaDKPuqTHGnzxhWlDc8no8eXueZ2A2EOlOs8,2007
+xradio/_utils/common.py,sha256=bjUZfZZrYTOt0i_XVfmQ2kvgr3egoYPWKGgnr4vKe-Y,46
+xradio/_utils/_casacore/tables.py,sha256=aq6E_4RRAHdTBCwMKrVil1cWhFU2O980DNH9IlRKXLw,1280
+xradio/_utils/zarr/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+xradio/_utils/zarr/common.py,sha256=I6Pl9e91onqxCslq7wMDxPD50fKntDGT7bAiM5CgTAg,5107
+xradio/image/__init__.py,sha256=HAD0GfopIbhdxOYckyW6S9US_dSWmZrwIl3FHUzZwrE,435
+xradio/image/image.py,sha256=QoJ_BTLoMfeXJzU1yvtidBIhaMmjNA5_-6C3FWJRUeI,15635
+xradio/image/_util/__init__.py,sha256=M9lxD1Gc7kv0ucDEDbjLRuIEuESev-IG8j9EaCKUAkA,77
+xradio/image/_util/casacore.py,sha256=DmBTHUQ6870N5ARuFnYSfjZSLniJYgsjrsICUlCREYM,4234
+xradio/image/_util/common.py,sha256=vQs7Du9FSkb_D64Syt3IkiWkb_GmG9xhDPdgbpgP9Ok,9031
+xradio/image/_util/fits.py,sha256=gyGm06fuCKqVGK7uv-ObvQNfFawUDsIOa_nQyklM3Aw,329
+xradio/image/_util/image_factory.py,sha256=6tPzs20FTm2wEshHc1xqtTV7D0TbKxGLUKAVtvOc68I,10506
+xradio/image/_util/zarr.py,sha256=lhQqVRC1GEWClG3zRbuDr2IlQBfXeDqaLUJIN-MVMxA,1652
+xradio/image/_util/_casacore/__init__.py,sha256=OlsiRE40o1jSbBI4khgQQzgfDYbAlOMKIhO4UFlbGhg,41
+xradio/image/_util/_casacore/common.py,sha256=ky999eTCWta8w-uIs-7P7rPhZRLuh9yTuQXAxPvaPm4,1579
+xradio/image/_util/_casacore/xds_from_casacore.py,sha256=Rht4A32QLAQ7uizwKfOsZ3Z819shvlUbsZfAuTIVerU,42562
+xradio/image/_util/_casacore/xds_to_casacore.py,sha256=P6c-yoOjuVQkm07ApA7FFKfje4aPwV-MsRFKaRaPq9I,15338
+xradio/image/_util/_fits/xds_from_fits.py,sha256=kpZ2gdbDQtoUD1DdQZymup5OVnB3e73D66LruLYESsw,28445
+xradio/image/_util/_zarr/common.py,sha256=apMX_bF4Hr3pFGjnDFpp36KgmhTYAPBZquNkjBHrsXk,307
+xradio/image/_util/_zarr/xds_from_zarr.py,sha256=hz6lHlpybfr_r8pn_uObDHOFmN5h75F11bkBv8KCuP0,3192
+xradio/image/_util/_zarr/xds_to_zarr.py,sha256=wogXbwX8n3Sl9PHoc3_Y_LBowQsQ-94HZQFZ5NcxUZA,1624
+xradio/image/_util/_zarr/zarr_low_level.py,sha256=JJ_NgYTAbfiOXkpqIv9nA3bvthaqTZtumVYsLse_qGU,11001
+xradio/schema/__init__.py,sha256=EzEMnOtN8G_wdjo8QBRKfq5MrYgfr_nt1pfunlI6i6Q,733
+xradio/schema/bases.py,sha256=9IUCCP9BwpGxi43vD1xsxszBx9u1KyfKtPoJ12oGPjA,15990
+xradio/schema/check.py,sha256=3bJPPWPryt1Mrb1ltwYrPeInXgm--EVJ6jcmfzOKxg8,18071
+xradio/schema/dataclass.py,sha256=LyYsHdorNrzqX1NFBr01vBM0vaBA7XY_TIkZXphMdns,12333
+xradio/schema/metamodel.py,sha256=WjtW7pAVzcjLRWifRH3sQoOiN6TV810hARpOIz1M_gw,3845
+xradio/schema/typing.py,sha256=8-o6fZd99kJ4FVdgBYRTIRJ-wDqpcUNXzCTfJvl3TIw,10439
+xradio/vis/__init__.py,sha256=0HFHuUezO-2eVn16IKAzVQCqL896Spaj_QIYjVY9Aq4,401
+xradio/vis/_processing_set.py,sha256=ZmrQms_ETDdvunGs8dGtdAKI0hm759LG-E6jjaCGiYI,5906
+xradio/vis/convert_msv2_to_processing_set.py,sha256=nT_19bFZk4NixAZq9Zy8n7HIUAfDz9i_iomL7d_lxYM,5068
+xradio/vis/load_processing_set.py,sha256=xREcp9G1Vywbb9Pc8_XUcbFypt_JAXNAIG5xEKOBEQ8,5807
+xradio/vis/read_processing_set.py,sha256=NTgcncF2knAPJVbD_1dKFuLDowJ6AM1kAIbwPdSQBTI,4067
+xradio/vis/schema.py,sha256=mYXHWuzcaTo1PD7A98BqcfMobI74UjklJaAp0J4wQTM,23577
+xradio/vis/vis_io.py,sha256=Onv0tBcix06Dc2b9UjXQzcTVlTvykG49KPO36tf5WKI,5714
+xradio/vis/_vis_utils/__init__.py,sha256=Scu6rKJ2SpO8aG7F-xdTZcYfyWx0viV8gFh8E8ur_gI,93
+xradio/vis/_vis_utils/ms.py,sha256=JcaFxidq-iL7tIbyv6F4qnMTeHediaumP_Y3RTAJvLw,5481
+xradio/vis/_vis_utils/ms_column_descriptions_dicts.py,sha256=BV2SyiAmIB8P8n-u8osKlKYKiOq8fmiFsB9xSxlkTrM,39906
+xradio/vis/_vis_utils/zarr.py,sha256=WlFPpcRZz2qXVyzrQ7MqmndhBm5NJUZZZaThDvx2Nw8,3962
+xradio/vis/_vis_utils/_ms/chunks.py,sha256=XiQWyzqxPSmcsb1RhKAuAO55YKPmBDnbUmfymLeEIFo,5414
+xradio/vis/_vis_utils/_ms/conversion.py,sha256=f9-2WaxjYushC-5eNYGienBW3iXRKvKFgBKw4KYcZ2A,32242
+xradio/vis/_vis_utils/_ms/descr.py,sha256=ymavAEnFUc6zIcncP_-72y8zoOYk7Sx-euPYWXkUSE0,5206
+xradio/vis/_vis_utils/_ms/msv2_msv3.py,sha256=9AKs2HWly7Ivv_Cjr11dIPGmm33_rtSBoGF9wN5ZwEQ,116
+xradio/vis/_vis_utils/_ms/msv2_to_msv4_meta.py,sha256=JWv8ggK3b3tBzxgbuQJ-eG0QFOI-Jnbp7fveee2FuDw,4972
+xradio/vis/_vis_utils/_ms/msv4_infos.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+xradio/vis/_vis_utils/_ms/msv4_sub_xdss.py,sha256=L5rg6TMkgLA_PvbOuu3khGcoFjGUHUp1E_1v-IrLWII,13411
+xradio/vis/_vis_utils/_ms/optimised_functions.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+xradio/vis/_vis_utils/_ms/partition_queries.py,sha256=onvci1ew4vQ5NS-pY7xGADyJRPXpeDsUgNRvX4WuLRc,19422
+xradio/vis/_vis_utils/_ms/partitions.py,sha256=0js5S1RBnf5ev2UjtqaPW-cmo0nhVup8UsLvKZgNPrQ,13157
+xradio/vis/_vis_utils/_ms/subtables.py,sha256=vwKXgt2CQ5EQLbaQ_3NBbkpWzH0aX7Q172ToYb7nXXY,3944
+xradio/vis/_vis_utils/_ms/_tables/create_field_and_source_xds.py,sha256=s7s0zUovGh5951TLDP4hQOBPnmn_B8m105_Qn_X20NI,24553
+xradio/vis/_vis_utils/_ms/_tables/load.py,sha256=QBKS41SyXtxiMAy6Yd6vneANvK6i7I-4z-z7ynMu0Vk,1837
+xradio/vis/_vis_utils/_ms/_tables/load_main_table.py,sha256=NsaZzrKWx5Eib2JqWR8ZEo7onxcmyFYMhJPqrQAUew4,14822
+xradio/vis/_vis_utils/_ms/_tables/read.py,sha256=BGR5ztiS4qdZwYG8mpYOBe9KsnqMayr_JmZ-Nlh-sVU,41454
+xradio/vis/_vis_utils/_ms/_tables/read_main_table.py,sha256=K41wByQ0yDOJGqCNcfZE29Y_z0VtkudPk0ioxkaZVsE,26130
+xradio/vis/_vis_utils/_ms/_tables/read_subtables.py,sha256=affBKTPeqD0qBYCbcqVvB6ujhsLf8PBLGb6n2aaNKeg,12454
+xradio/vis/_vis_utils/_ms/_tables/table_query.py,sha256=q8EGFf_zIwHcHnvFJOn8hPh8zFZQ3f7BGbXvL3bHad4,555
+xradio/vis/_vis_utils/_ms/_tables/write.py,sha256=URL7KOw6Sohu6lr4LRWVz3KkDzR8DoVS-P_oV3ibRXU,9599
+xradio/vis/_vis_utils/_ms/_tables/write_exp_api.py,sha256=INniN_sVOZ0DmhHU3k0B4JT10Q4cqpySUvJ_OOiG9K0,15308
+xradio/vis/_vis_utils/_utils/cds.py,sha256=OpvKowSheIthUbcPEv2AoKmxlEt3DqJZS5C1AYh5z10,1179
+xradio/vis/_vis_utils/_utils/partition_attrs.py,sha256=GgItjC6wQ6UXUzypGz-lOllNMtEs0UYmSEeEjAE86c8,3401
+xradio/vis/_vis_utils/_utils/stokes_types.py,sha256=DMa8TmmS7BQ99Xm8c7ZjcRapMtLbrKVxrt4f0qUIOvg,561
+xradio/vis/_vis_utils/_utils/xds_helper.py,sha256=ggv3ArWMN75tklA5v0WxjfBM6rSvUBVBNtgZp1_rU2M,13094
+xradio/vis/_vis_utils/_zarr/encoding.py,sha256=GENIlThV6a9CUCL6gIGlu9c6NR3OFWNos6mpxZjMwDc,536
+xradio/vis/_vis_utils/_zarr/read.py,sha256=9UKX_kKztE5jhsriBPnLhWtbptk5DRSVUEHT8V5qh8w,7597
+xradio/vis/_vis_utils/_zarr/write.py,sha256=vebYh-rAKfY3Feuv6H400s-2UuciPtfZMIlMtb23YSk,10044
+xradio-0.0.30.dist-info/LICENSE.txt,sha256=9CYIJt7riOXo9AD0eXBZviLxo_HebD-2JJI8oiWtzfg,1807
+xradio-0.0.30.dist-info/METADATA,sha256=ln-6BSbfL6qcPWrskhLb4sMhvYBZ2TReO5kUBmTKTP0,4449
+xradio-0.0.30.dist-info/WHEEL,sha256=Z4pYXqR_rTB7OWNDYFOm1qRk0RX6GFP2o8LgvP453Hk,91
+xradio-0.0.30.dist-info/top_level.txt,sha256=dQu27fGBZJ2Yk-gW5XeD-dZ76Xa4Xcvk60Vz-dwXp7k,7
+xradio-0.0.30.dist-info/RECORD,,

{xradio-0.0.28.dist-info → xradio-0.0.30.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.43.0)
+Generator: setuptools (70.3.0)
 Root-Is-Purelib: true
 Tag: py3-none-any