Resolve merge conflicts

Author: camposandro

.copier-answers.yml

@@ -15,9 +15,9 @@ include_benchmarks: true
 include_docs: true
 include_notebooks: true
 mypy_type_checking: none
-package_name: hipscat
+package_name: hats
 project_license: BSD
-project_name: hipscat
+project_name: hats
 project_organization: astronomy-commons
 python_versions:
 - '3.9'

.github/workflows/build-documentation.yml

@@ -5,9 +5,9 @@ name: Build documentation
 
 on:
   push:
-    branches: [ main, development ]
+    branches: [ main ]
   pull_request:
-    branches: [ main, development ]
+    branches: [ main ]
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}

.github/workflows/pre-commit-ci.yml

@@ -5,9 +5,9 @@ name: Run pre-commit hooks
 
 on:
   push:
-    branches: [ main, development ]
+    branches: [ main ]
   pull_request:
-    branches: [ main, development ]
+    branches: [ main ]
 
 jobs:
   pre-commit-ci:

.github/workflows/testing-and-coverage.yml

@@ -5,9 +5,9 @@ name: Unit test and code coverage
 
 on:
   push:
-    branches: [ main, development ]
+    branches: [ main ]
   pull_request:
-    branches: [ main, development ]
+    branches: [ main ]
 
 jobs:
   build:
@@ -31,7 +31,7 @@ jobs:
         if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
     - name: Run unit tests with pytest
       run: |
-        python -m pytest --cov=hipscat --cov-report=xml
+        python -m pytest --cov=hats --cov-report=xml
     - name: Upload coverage report to codecov
       uses: codecov/codecov-action@v4
       with:

README.md

@@ -1,38 +1,38 @@
 <img src="https://github.com/astronomy-commons/lsdb/blob/main/docs/lincc-logo.png?raw=true" width="300" height="100">
 
-# HiPSCat
+# HATS
 
 [![Template](https://img.shields.io/badge/Template-LINCC%20Frameworks%20Python%20Project%20Template-brightgreen)](https://lincc-ppt.readthedocs.io/en/stable/)
 
-[![PyPI](https://img.shields.io/pypi/v/hipscat?color=blue&logo=pypi&logoColor=white)](https://pypi.org/project/hipscat/)
-[![Conda](https://img.shields.io/conda/vn/conda-forge/hipscat.svg?color=blue&logo=condaforge&logoColor=white)](https://anaconda.org/conda-forge/hipscat)
+[![PyPI](https://img.shields.io/pypi/v/hats?color=blue&logo=pypi&logoColor=white)](https://pypi.org/project/hats/)
+[![Conda](https://img.shields.io/conda/vn/conda-forge/hats.svg?color=blue&logo=condaforge&logoColor=white)](https://anaconda.org/conda-forge/hats)
 
-[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/astronomy-commons/hipscat/smoke-test.yml)](https://github.com/astronomy-commons/hipscat/actions/workflows/smoke-test.yml)
-[![codecov](https://codecov.io/gh/astronomy-commons/hipscat/branch/main/graph/badge.svg)](https://codecov.io/gh/astronomy-commons/hipscat)
-[![Read the Docs](https://img.shields.io/readthedocs/hipscat)](https://hipscat.readthedocs.io/)
-[![benchmarks](https://img.shields.io/github/actions/workflow/status/astronomy-commons/hipscat/asv-main.yml?label=benchmarks)](https://astronomy-commons.github.io/hipscat/)
+[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/astronomy-commons/hats/smoke-test.yml)](https://github.com/astronomy-commons/hats/actions/workflows/smoke-test.yml)
+[![codecov](https://codecov.io/gh/astronomy-commons/hats/branch/main/graph/badge.svg)](https://codecov.io/gh/astronomy-commons/hats)
+[![Read the Docs](https://img.shields.io/readthedocs/hats)](https://hats.readthedocs.io/)
+[![benchmarks](https://img.shields.io/github/actions/workflow/status/astronomy-commons/hats/asv-main.yml?label=benchmarks)](https://astronomy-commons.github.io/hats/)
 
-## Hierarchical Progressive Survey Catalog
+## Hierarchical Adaptive Tiling Scheme
 
-A HiPSCat catalog is a partitioning of objects on a sphere. Its purpose is for 
+A HATS catalog is a partitioning of objects on a sphere. Its purpose is for 
 storing data from large astronomy surveys, but could probably be used for other 
 use cases where you have large data with some spherical properties.
 
-Check out our [ReadTheDocs site](https://hipscat.readthedocs.io/en/stable/)
+Check out our [ReadTheDocs site](https://hats.readthedocs.io/en/stable/)
 for more information on partitioning, installation, and contributing.
 
 See related projects:
 
-* HiPSCat Import ([on GitHub](https://github.com/astronomy-commons/hipscat-import))
-  ([on ReadTheDocs](https://hipscat-import.readthedocs.io/en/stable/))
+* HATS Import ([on GitHub](https://github.com/astronomy-commons/hats-import))
+  ([on ReadTheDocs](https://hats-import.readthedocs.io/en/stable/))
 * LSDB ([on GitHub](https://github.com/astronomy-commons/lsdb)) 
   ([on ReadTheDocs](https://lsdb.readthedocs.io/en/stable/))
 
 ## Contributing
 
-[![GitHub issue custom search in repo](https://img.shields.io/github/issues-search/astronomy-commons/hipscat?color=purple&label=Good%20first%20issues&query=is%3Aopen%20label%3A%22good%20first%20issue%22)](https://github.com/astronomy-commons/hipscat/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
+[![GitHub issue custom search in repo](https://img.shields.io/github/issues-search/astronomy-commons/hats?color=purple&label=Good%20first%20issues&query=is%3Aopen%20label%3A%22good%20first%20issue%22)](https://github.com/astronomy-commons/hats/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
 
-See the [contribution guide](https://hipscat.readthedocs.io/en/stable/guide/contributing.html)
+See the [contribution guide](https://hats.readthedocs.io/en/stable/guide/contributing.html)
 for completed installation instructions and contribution best practices.
 
 ## Acknowledgements

benchmarks/asv.conf.json

@@ -3,9 +3,9 @@
     // you know what you are doing.
     "version": 1,
     // The name of the project being benchmarked.
-    "project": "hipscat",
+    "project": "hats",
     // The project's homepage.
-    "project_url": "https://github.com/astronomy-commons/hipscat",
+    "project_url": "https://github.com/astronomy-commons/hats",
     // The URL or local path of the source code repository for the
     // project being benchmarked.
     "repo": "..",
@@ -33,7 +33,7 @@
     // variable.
     "environment_type": "virtualenv",
     // the base URL to show a commit for the project.
-    "show_commit_url": "https://github.com/astronomy-commons/hipscat/commit",
+    "show_commit_url": "https://github.com/astronomy-commons/hats/commit",
     // The Pythons you'd like to test against. If not provided, defaults
     // to the current version of Python used to run `asv`.
     "pythons": [

benchmarks/benchmarks.py

@@ -7,15 +7,14 @@
 
 import numpy as np
 
-import hipscat.pixel_math as hist
-import hipscat.pixel_math.healpix_shim as hp
-from hipscat.catalog import Catalog, PartitionInfo
-from hipscat.catalog.association_catalog.partition_join_info import PartitionJoinInfo
-from hipscat.catalog.catalog_info import CatalogInfo
-from hipscat.io.paths import pixel_catalog_files
-from hipscat.pixel_math import HealpixPixel
-from hipscat.pixel_tree import PixelAlignment, align_trees
-from hipscat.pixel_tree.pixel_tree import PixelTree
+import hats.pixel_math as hist
+import hats.pixel_math.healpix_shim as hp
+from hats.catalog import Catalog, PartitionInfo, TableProperties
+from hats.catalog.association_catalog.partition_join_info import PartitionJoinInfo
+from hats.io.paths import pixel_catalog_files
+from hats.pixel_math import HealpixPixel
+from hats.pixel_tree import PixelAlignment, align_trees
+from hats.pixel_tree.pixel_tree import PixelTree
 
 
 def time_test_alignment_even_sky():
@@ -29,12 +28,11 @@ def time_test_alignment_even_sky():
 
 def time_test_cone_filter_multiple_order():
     """Create a catalog cone filter where we have multiple orders in the catalog"""
-    catalog_info = CatalogInfo(
+    catalog_info = TableProperties(
         **{
             "catalog_name": "test_name",
             "catalog_type": "object",
             "total_rows": 10,
-            "epoch": "J2000",
             "ra_column": "ra",
             "dec_column": "dec",
         }

docs/_static/gaia.png

@@ -14,10 +14,10 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-project = "hipscat"
+project = "hats"
 copyright = "2023, LINCC Frameworks"
 author = "LINCC Frameworks"
-release = version("hipscat")
+release = version("hats")
 # for example take major/minor
 version = ".".join(release.split(".")[:2])
 

docs/conf.py

@@ -0,0 +1,48 @@
+Getting Started with HATS
+=========================
+
+Installation
+------------
+
+The latest release version of HATS is available to install with `pip <https://pypi.org/project/hats/>`_ (with conda coming soon).
+
+.. code-block:: bash
+
+    python -m pip install hats
+
+.. hint::
+
+    We recommend using a virtual environment. Before installing the package, create and activate a fresh
+    environment. Here are some examples with different tools:
+
+    .. tab-set::
+
+        .. tab-item:: venv
+
+            .. code-block:: bash
+
+                python -m venv ./hats_env
+                source ./hats_env/bin/activate
+
+        .. tab-item:: pyenv
+
+            With the pyenv-virtualenv plug-in:
+
+            .. code-block:: bash
+
+                pyenv virtualenv 3.11 hats_env
+                pyenv local hats_env
+
+    We recommend Python versions **>=3.9, <=3.12**.
+
+HATS can also be installed from source on `GitHub <https://github.com/astronomy-commons/hats>`_.
+
+
+LSDB
+----
+
+For the most part, we recommend accessing and processing HATS data using the `LSDB package
+<https://github.com/astronomy-commons/lsdb>`_ framework. LSDB provides a variety of utility
+functions as well as a lazy, distributed execution framework using Dask.
+
+For detail on LSDB, see the `readthedocs site <https://docs.lsdb.io/en/stable/>`_.

docs/getting_started.rst

@@ -1,4 +1,4 @@
-Contributing to hipscat
+Contributing to hats
 ===============================================================================
 
 Find (or make) a new GitHub issue
@@ -61,14 +61,14 @@ Notes:
 
     Native prebuilt binaries for healpy on Apple Silicon Macs 
     `do not yet exist <https://healpy.readthedocs.io/en/latest/install.html#binary-installation-with-pip-recommended-for-most-other-python-users>`_, 
-    so it's recommended to install via conda before proceeding to hipscat.
+    so it's recommended to install via conda before proceeding to hats.
 
     .. code-block:: bash
 
         $ conda config --add channels conda-forge
         $ conda install healpy
-        $ git clone https://github.com/astronomy-commons/hipscat
-        $ cd hipscat
+        $ git clone https://github.com/astronomy-commons/hats
+        $ cd hats
         $ pip install -e .
         
     When installing dev dependencies, make sure to include the single quotes.

docs/guide/contributing.rst

@@ -1,4 +1,4 @@
-HiPSCat Directory Scheme
+HATS Directory Scheme
 ===============================================================================
 
 Partitioning Scheme
@@ -11,22 +11,40 @@ In areas of the sky with more objects, we use smaller pixels, so that all the
 resulting pixels should contain similar counts of objects (within an order of 
 magnitude).
 
+The following figure is a possible HATS partitioning. Note: 
+
+* darker/bluer areas are stored in low order / high area tiles
+* lighter/yellower areas are stored in higher order / lower area tiles
+* the galactic plane is very prominent!
+
+.. figure:: /_static/gaia.png
+   :class: no-scaled-link
+   :scale: 80 %
+   :align: center
+   :alt: A possible HEALPix distribution for Gaia DR3
+
+   A possible HEALPix distribution for Gaia DR3.
+
 File structure
 -------------------------------------------------------------------------------
 
 The catalog reader expects to find files according to the following partitioned 
 structure:
 
 .. code-block:: 
-        
+    :class: no-copybutton
+    
     __ /path/to/catalogs/<catalog_name>/
-       |__ catalog_info.json
        |__ partition_info.csv
-       |__ Norder=1/
-       |   |__ Dir=0/
-       |       |__ Npix=0.parquet
-       |       |__ Npix=1.parquet
-       |__ Norder=J/
-           |__ Dir=10000/
-               |__ Npix=K.parquet
-               |__ Npix=M.parquet
+       |__ properties
+       |__ dataset/
+           |__ _common_metadata
+           |__ _metadata
+           |__ Norder=1/
+           |   |__ Dir=0/
+           |       |__ Npix=0.parquet
+           |       |__ Npix=1.parquet
+           |__ Norder=J/
+               |__ Dir=10000/
+                   |__ Npix=K.parquet
+                   |__ Npix=M.parquet