Merge pull request #105 from radionets-project/move_gridder

Remove gridding and replace with pyvisgrid methods

Author: tgross03

.github/workflows/ci.yml

@@ -86,6 +86,10 @@ jobs:
         if: matrix.environment-type == 'mamba'
         run: micromamba list
 
+      - name: Create CASA data directory
+        run: |
+          mkdir -p $HOME/.casa/data
+
       - name: Tests
         run: |
           pytest -vv --cov --cov-report=xml --junitxml=junit.xml -o junit_family=legacy
@@ -122,6 +126,10 @@ jobs:
           uv pip install --system . --group docs -e .
           git describe --tags
 
+      - name: Create CASA data directory
+        run: |
+          mkdir -p $HOME/.casa/data
+
       - name: Build docs
         run: make -C docs html
 

.readthedocs.yaml

@@ -11,6 +11,7 @@ build:
          - asdf plugin add uv
          - asdf install uv latest
          - asdf global uv latest
+         - mkdir -p $HOME/.casa/data
     install:
       - uv pip install --upgrade pip
       - uv pip install --group docs .

docs/api-reference/dataset/dataset.rst

@@ -0,0 +1,17 @@
+
+.. _dataset_dataset:
+
+*****************************************
+Dataset (:mod:`pyvisgen.dataset.dataset`)
+*****************************************
+
+.. currentmodule:: pyvisgen.dataset.dataset
+
+Dataset submodule of :mod:`pyvisgen.dataset`.
+
+
+Reference/API
+=============
+
+.. automodapi:: pyvisgen.dataset.dataset
+    :inherited-members:

docs/api-reference/dataset/index.rst

@@ -0,0 +1,32 @@
+
+.. _dataset:
+
+*********************************
+Dataset (:mod:`pyvisgen.dataset`)
+*********************************
+
+.. currentmodule:: pyvisgen.dataset
+
+
+Introduction
+============
+
+:mod:`pyvisgen.dataset` contains methods create datasets consisting of simulated
+visibilities and the corresponding true model images.
+
+Submodules
+==========
+
+.. toctree::
+  :maxdepth: 1
+  :glob:
+
+  dataset
+  utils
+
+
+Reference/API
+=============
+
+.. automodapi:: pyvisgen.dataset
+    :no-inheritance-diagram:

docs/api-reference/dataset/utils.rst

@@ -0,0 +1,16 @@
+.. _dataset_utils:
+
+*********************************************
+Dataset Utils (:mod:`pyvisgen.dataset.utils`)
+*********************************************
+
+.. currentmodule:: pyvisgen.dataset.utils
+
+Utility submodule of :mod:`pyvisgen.dataset`.
+
+
+Reference/API
+=============
+
+.. automodapi:: pyvisgen.dataset.utils
+    :inherited-members:

docs/api-reference/gridding/index.rst

@@ -21,7 +21,6 @@ Submodules
   :glob:
 
   array
-  data_set
   observation
   scan
   visibility

docs/api-reference/simulation/data_set.rst

@@ -0,0 +1,4 @@
+- Removed gridding methods and replace it with [``pyvisgrid``](https://github.com/radionets-project/pyvisgrid)
+- Add ``pyvisgrid`` as dependency to ``pyproject.toml``
+- Move the dataset creation, utility methods and scripts to a ``dataset`` module of pyvisgen.
+- Fix typo ``sensitivty_cut`` for dataset config

docs/api-reference/simulation/index.rst

@@ -42,6 +42,7 @@ dependencies = [
   "natsort",
   "numpy",
   "pandas",
+  "pyvisgrid",
   "rich",
   "rich-click>=1.8.9",
   "scipy",
@@ -52,14 +53,9 @@ dependencies = [
 ]
 
 [project.optional-dependencies]
-plot = [
-  "matplotlib",
-]
+plot = ["matplotlib"]
 
-tutorials = [
-  "matplotlib",
-  "pytorch_finufft"
-]
+tutorials = ["matplotlib", "pytorch_finufft"]
 
 [dependency-groups]
 tests = [
@@ -101,12 +97,12 @@ dev = [
   "jupyter",
   "pre-commit",
   "pytorch_finufft",
-  {include-group = "tests"},
-  {include-group = "docs"},
+  { include-group = "tests" },
+  { include-group = "docs" },
 ]
 
 [project.scripts]
-pyvisgen-simulate = "pyvisgen.simulation.scripts.create_dataset:main"
+pyvisgen-simulate = "pyvisgen.dataset.scripts.create_dataset:main"
 pyvisgen-quickstart = "pyvisgen.tools.quickstart:quickstart"
 
 [tool.hatch.version]
@@ -125,6 +121,9 @@ include = ["src/pyvisgen"]
 "resources" = "share/resources"
 "config" = "share/configs"
 
+[tool.hatch.metadata]
+"allow-direct-references" = true
+
 [tool.coverage.run]
 omit = [
   "docs/*",
@@ -143,7 +142,7 @@ extend-exclude = ["tests", "examples"]
 
 [tool.ruff.lint]
 extend-select = [
-  "I",  # isort
+  "I", # isort
 ]
 ignore = []
 
@@ -161,33 +160,33 @@ docstring-code-format = true
 known-first-party = ["pyvisgen"]
 
 [tool.towncrier]
-    package = "pyvisgen"
-    directory = "docs/changes"
-    filename = "CHANGES.rst"
-    template = "docs/changes/template.rst"
-    # let towncrier create proper links to the merged PR
-    issue_format = "`#{issue} <https://github.com/radionets-project/pyvisgen/pull/{issue}>`__"
-
-    [tool.towncrier.fragment.feature]
-        name = "New Features"
-        showcontent = true
-
-    [tool.towncrier.fragment.bugfix]
-        name = "Bug Fixes"
-        showcontent = true
-
-    [tool.towncrier.fragment.api]
-        name = "API Changes"
-        showcontent = true
-
-    [tool.towncrier.fragment.optimization]
-        name = "Refactoring and Optimization"
-        showcontent = true
-
-    [tool.towncrier.fragment.maintenance]
-        name = "Maintenance"
-        showcontent = true
-
-    [[tool.towncrier.section]]
-        name = ""
-        path = ""
+package = "pyvisgen"
+directory = "docs/changes"
+filename = "CHANGES.rst"
+template = "docs/changes/template.rst"
+# let towncrier create proper links to the merged PR
+issue_format = "`#{issue} <https://github.com/radionets-project/pyvisgen/pull/{issue}>`__"
+
+[tool.towncrier.fragment.feature]
+name = "New Features"
+showcontent = true
+
+[tool.towncrier.fragment.bugfix]
+name = "Bug Fixes"
+showcontent = true
+
+[tool.towncrier.fragment.api]
+name = "API Changes"
+showcontent = true
+
+[tool.towncrier.fragment.optimization]
+name = "Refactoring and Optimization"
+showcontent = true
+
+[tool.towncrier.fragment.maintenance]
+name = "Maintenance"
+showcontent = true
+
+[[tool.towncrier.section]]
+name = ""
+path = ""