Merge pull request #287 from casangi/268-processing-set-and-correlated-data-functionality

Fix links.

Author: Jan-Willem

docs/source/measurement_set_overview.ipynb

@@ -6,7 +6,7 @@
    "source": [
     "# Overview\n",
     "\n",
-    "The Measurement Set v4 (MS v4) schema defines how correlated data (interferometer visibilities and single-dish spectra) can be represented in memory using datasets that consist of n-dimensional arrays labeled with coordinates and meta-information contained in attributes (see [foundational reading](https://xradio.readthedocs.io/en/latest/overview.html#Foundational-Reading)). The MS v4 implementation differs from the `MS v2` implementation in [`casacore`](https://github.com/casacore/casacore) primarily in its use of Python and off-the-shelf packages for data structures and data serialization, contrasting with `casacore's` bespoke C++ approach.\n",
+    "The Measurement Set v4 (MS v4) schema defines how correlated data (interferometer visibilities and single-dish spectra) can be represented in memory using datasets that consist of n-dimensional arrays labeled with coordinates and meta-information contained in attributes (see [foundational reading](https://xradio.readthedocs.io/en/latest/overview.html#Foundational-Reading)). The MS v4 implementation differs from the `MS v2` implementation in [casacore](https://github.com/casacore/casacore) primarily in its use of Python and off-the-shelf packages for data structures and data serialization, contrasting with `casacore's` bespoke C++ approach.\n",
     "\n",
     "Reference documents consulted for the MS v4 schema design:\n",
     "\n",
@@ -177,7 +177,7 @@
     "    </figure>\n",
     "</div>\n",
     "\n",
-    "[Figure 3](#figure-3) summarizes the available and planned future functionality. The sub-package currently allows direct opening of data from [zarr](https://zarr-specs.readthedocs.io/en/latest/specs.html) and will support WSU ASDM (Wide Band Sensitivity Upgrade) and [NetCDF](https://www.unidata.ucar.edu/software/netcdf/) in the future. The WSU ASDM is an update of the [ASDM](https://drive.google.com/file/d/1PMrZFbkrMVfe57K6AAh1dR1FalS35jP2/view) implementation required by [ALMA WSU](https://science.nrao.edu/facilities/alma/science_sustainability/wideband-sensitivity-upgrade) where the spectral windows are no longer interleaved. Both zarr and NetCDF support cloud storage, and [`open_processing_set`](https://xradio.readthedocs.io/en/latest/measurement_set/schema_and_api/measurement_set_api.html#xradio.measurement_set.open_processing_set) and [`load_processing_set`](https://xradio.readthedocs.io/en/latest/measurement_set/schema_and_api/measurement_set_api.html#xradio.measurement_set.load_processing_set) support accessing data on [Amazon S3](https://aws.amazon.com/s3/).\n",
+    "[Figure 3](#figure-3) summarizes the available and planned future functionality. The sub-package currently allows direct opening of data from [zarr](https://zarr-specs.readthedocs.io/en/latest/specs.html) and will support WSU ASDM (Wide Band Sensitivity Upgrade) and [NetCDF](https://www.unidata.ucar.edu/software/netcdf/) in the future. The WSU ASDM is an update of the [ASDM](https://drive.google.com/file/d/1PMrZFbkrMVfe57K6AAh1dR1FalS35jP2/view) implementation required by [ALMA WSU](https://science.nrao.edu/facilities/alma/science_sustainability/wideband-sensitivity-upgrade) where the spectral windows are no longer interleaved. Both zarr and NetCDF support cloud storage, and [open_processing_set](https://xradio.readthedocs.io/en/latest/measurement_set/schema_and_api/measurement_set_api.html#xradio.measurement_set.open_processing_set) and [load_processing_set](https://xradio.readthedocs.io/en/latest/measurement_set/schema_and_api/measurement_set_api.html#xradio.measurement_set.load_processing_set) support accessing data on [Amazon S3](https://aws.amazon.com/s3/).\n",
     "\n",
     "<div style=\"text-align: center;\">\n",
     "    <figure id=\"figure-3\" style=\"display: inline-block;\">\n",

docs/source/overview.ipynb

@@ -122,7 +122,7 @@
     "cd xradio\n",
     " pip install -e \".[all]\"\n",
     "```\n",
-    "The `-e` ensures that the installation location is the same as the cloned repository (using `pip list` should show this), so that you can directly modify the cloned repo. The `[all]` ensures that all dependencies so that you can run the interactive Jupyter notebooks and build the documentation (the dependencies can be found in the [`pyproject.toml`](https://github.com/casangi/xradio/blob/main/pyproject.toml)).\n",
+    "The `-e` ensures that the installation location is the same as the cloned repository (using `pip list` should show this), so that you can directly modify the cloned repo. The `[all]` ensures that all dependencies so that you can run the interactive Jupyter notebooks and build the documentation (the dependencies can be found in the [pyproject.toml](https://github.com/casangi/xradio/blob/main/pyproject.toml)).\n",
     "\n",
     "### Building documentation\n",
     "\n",
@@ -144,12 +144,12 @@
     "- **Docstrings**: All functions and classes should include NumPy-style docstrings. For guidelines, refer to the [NumPy Documentation Guide](https://numpydoc.readthedocs.io/en/latest/format.html).\n",
     "- **Compute-Intensive Code**: Ensure that compute-intensive code is vectorized for performance. If vectorization is not feasible, consider using [Numba](https://github.com/numba/numba). Use performance testing to verify that optimizations are effective.\n",
     "- **Testing**: Write unit tests for all major functions and classes using [pytest](https://docs.pytest.org/en/latest/). The folder structure of `xradio/tests/unit` should mirror the source code structure.\n",
-    "- **Error Handling & Logging**: Use the [`toolviper`](https://github.com/casangi/toolviper/blob/main/docs/graphviper-logger-formatting-example.ipynb) logger for consistent logging.\n",
+    "- **Error Handling & Logging**: Use the [toolviper](https://github.com/casangi/toolviper/blob/main/docs/graphviper-logger-formatting-example.ipynb) logger for consistent logging.\n",
     "\n",
     "### Submitting Code\n",
     "\n",
     "- Any code you submit is under the [BSDv3 license](https://github.com/casangi/xradio/blob/main/LICENSE.txt) and you will have to agree with our [contributor license agreement](https://github.com/casangi/xradio/blob/main/CONTRIBUTOR_LICENSING_AGREEMENT.txt) that protects you and the XRADIO project from liability.\n",
-    "- Create an issue on github outlining what you would to contribute [`XRADIO GitHub repository](https://github.com/casangi/xradio/issues).\n",
+    "- Create an issue on github outlining what you would to contribute [XRADIO GitHub repository](https://github.com/casangi/xradio/issues).\n",
     "- Once there is agreement on the scope of the contribution you can create a branch on github or in you clones repository:\n",
     "```sh\n",
     "  git checkout -b feature-or-fix-name\n",