refactor: rename package to coordinax (#50)

* refactor: rename package to coordinax * jaxquantity version Signed-off-by: nstarman <[email protected]>
GalacticDynamics · Mar 2, 2024 · 2c96275 · 2c96275
1 parent 5e2af16
commit 2c96275
Show file tree

Hide file tree

Showing 43 changed files with 298 additions and 286 deletions.
diff --git a/.copier-answers.yml b/.copier-answers.yml
@@ -6,7 +6,7 @@ email: [email protected]
 full_name: Nathaniel Starkman
 license: BSD
 org: GalacticDynamics
-project_name: vector
+project_name: coordinax
 project_short_description: Vectors in Jax
-url: https://github.com/GalacticDynamics/vector
+url: https://github.com/GalacticDynamics/coordinax
 vcs: true
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -71,7 +71,7 @@ pytest
 Use pytest-cov to generate coverage reports:
 
 ```bash
-pytest --cov=vector
+pytest --cov=coordinax
 ```
 
 # Building docs

diff --git a/LICENSE b/LICENSE
@@ -13,7 +13,7 @@ modification, are permitted provided that the following conditions are met:
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.
 
-* Neither the name of the vector package developers nor the names of its
+* Neither the name of the coordinax package developers nor the names of its
   contributors may be used to endorse or promote products derived from
   this software without specific prior written permission.
 

diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# vector
+# coordinax
 
 [![Actions Status][actions-badge]][actions-link]
 [![Documentation Status][rtd-badge]][rtd-link]
@@ -12,16 +12,16 @@
 <!-- SPHINX-START -->
 
 <!-- prettier-ignore-start -->
-[actions-badge]:            https://github.com/GalacticDynamics/vector/workflows/CI/badge.svg
-[actions-link]:             https://github.com/GalacticDynamics/vector/actions
-[conda-badge]:              https://img.shields.io/conda/vn/conda-forge/vector
-[conda-link]:               https://github.com/conda-forge/vector-feedstock
+[actions-badge]:            https://github.com/GalacticDynamics/coordinax/workflows/CI/badge.svg
+[actions-link]:             https://github.com/GalacticDynamics/coordinax/actions
+[conda-badge]:              https://img.shields.io/conda/vn/conda-forge/coordinax
+[conda-link]:               https://github.com/conda-forge/coordinax-feedstock
 [github-discussions-badge]: https://img.shields.io/static/v1?label=Discussions&message=Ask&color=blue&logo=github
-[github-discussions-link]:  https://github.com/GalacticDynamics/vector/discussions
-[pypi-link]:                https://pypi.org/project/vector/
-[pypi-platforms]:           https://img.shields.io/pypi/pyversions/vector
-[pypi-version]:             https://img.shields.io/pypi/v/vector
-[rtd-badge]:                https://readthedocs.org/projects/vector/badge/?version=latest
-[rtd-link]:                 https://vector.readthedocs.io/en/latest/?badge=latest
+[github-discussions-link]:  https://github.com/GalacticDynamics/coordinax/discussions
+[pypi-link]:                https://pypi.org/project/coordinax/
+[pypi-platforms]:           https://img.shields.io/pypi/pyversions/coordinax
+[pypi-version]:             https://img.shields.io/pypi/v/coordinax
+[rtd-badge]:                https://readthedocs.org/projects/coordinax/badge/?version=latest
+[rtd-link]:                 https://coordinax.readthedocs.io/en/latest/?badge=latest
 
 <!-- prettier-ignore-end -->
diff --git a/docs/conf.py b/docs/conf.py
@@ -4,10 +4,10 @@
 
 import importlib.metadata
 
-project = "vector"
+project = "coordinax"
 copyright = "2023, Nathaniel Starkman"
 author = "Nathaniel Starkman"
-version = release = importlib.metadata.version("vector")
+version = release = importlib.metadata.version("coordinax")
 
 extensions = [
     "myst_parser",

diff --git a/docs/index.md b/docs/index.md
@@ -1,4 +1,4 @@
-# vector
+# coordinax
 
 ```{toctree}
 :maxdepth: 2

diff --git a/noxfile.py b/noxfile.py
@@ -32,7 +32,7 @@ def pylint(session: nox.Session) -> None:
     # This needs to be installed into the package environment, and is slower
     # than a pre-commit check
     session.install(".", "pylint")
-    session.run("pylint", "vector", *session.posargs)
+    session.run("pylint", "coordinax", *session.posargs)
 
 
 @nox.session
@@ -101,7 +101,7 @@ def build_api_docs(session: nox.Session) -> None:
         "--module-first",
         "--no-toc",
         "--force",
-        "../src/vector",
+        "../src/coordinax",
     )
 
 

diff --git a/pyproject.toml b/pyproject.toml
@@ -29,19 +29,19 @@
     "jax",
     "jaxlib",
     "jaxtyping",
-    "jax_quantity @ git+https://github.com/GalacticDynamics/jax-quantity.git",
+    "jax_quantity >= 0.2.1",
     "quax>=0.0.3",
   ]
   description = "Vectors in JAX"
   dynamic = ["version"]
   license.file = "LICENSE"
-  name = "vector"
+  name = "coordinax"
   readme = "README.md"
   requires-python = ">=3.10"
 
   [project.optional-dependencies]
-    all = ["vector[docs]", "vector[dev]", "vector[test]"]
-    dev = ["vector[test]"]
+    all = ["coordinax[docs]", "coordinax[dev]", "coordinax[test]"]
+    dev = ["coordinax[test]"]
     docs = [
       "furo>=2023.08.17",
       "myst_parser>=0.13",
@@ -59,14 +59,14 @@
     ]
 
   [project.urls]
-    "Bug Tracker" = "https://github.com/GalacticDynamics/vector/issues"
-    Changelog = "https://github.com/GalacticDynamics/vector/releases"
-    Discussions = "https://github.com/GalacticDynamics/vector/discussions"
-    Homepage = "https://github.com/GalacticDynamics/vector"
+    "Bug Tracker" = "https://github.com/GalacticDynamics/coordinax/issues"
+    Changelog = "https://github.com/GalacticDynamics/coordinax/releases"
+    Discussions = "https://github.com/GalacticDynamics/coordinax/discussions"
+    Homepage = "https://github.com/GalacticDynamics/coordinax"
 
 
 [tool.hatch]
-  build.hooks.vcs.version-file = "src/vector/_version.py"
+  build.hooks.vcs.version-file = "src/coordinax/_version.py"
   metadata.allow-direct-references = true
   version.source = "vcs"
 
@@ -95,7 +95,7 @@
 
 
 [tool.coverage]
-  run.source = ["vector"]
+  run.source = ["coordinax"]
 
   [tool.coverage.report]
     exclude_also = [
@@ -128,7 +128,7 @@
   [[tool.mypy.overrides]]
     disallow_incomplete_defs = true
     disallow_untyped_defs = true
-    module = "vector.*"
+    module = "coordinax.*"
 
   [[tool.mypy.overrides]]
     ignore_missing_imports = true
@@ -139,7 +139,7 @@
       "equinox.*",
       "hypothesis.*",
       "jax.*",
-      "vector.*",
+      "coordinax.*",
       "jaxtyping.*",
       "numpy.*",
       "quax.*",
@@ -178,7 +178,7 @@
       "TD003",   # Missing issue link on the line following this TODO
     ]
     # Uncomment if using a _compat.typing backport
-    # typing-modules = ["vector._compat.typing"]
+    # typing-modules = ["coordinax._compat.typing"]
 
     [tool.ruff.lint.per-file-ignores]
       "__init__.py" = ["F403"]
@@ -189,7 +189,7 @@
     [tool.ruff.lint.isort]
       combine-as-imports = true
       known-first-party = ["array_api_jax_compat", "jax_quantity"]
-      known-local-folder = ["vector"]
+      known-local-folder = ["coordinax"]
 
 
 [tool.pylint]

diff --git a/src/vector/__init__.py → src/coordinax/__init__.py b/src/vector/__init__.py → src/coordinax/__init__.py
@@ -2,15 +2,15 @@
 
 """Copyright (c) 2023 Nathaniel Starkman. All rights reserved.
 
-vector: Vectors in JAX
+coordinax: Vectors in JAX
 """
 
 from jaxtyping import install_import_hook
 
 from ._version import version as __version__
 from .setup_package import RUNTIME_TYPECHECKER
 
-with install_import_hook("vector", RUNTIME_TYPECHECKER):
+with install_import_hook("coordinax", RUNTIME_TYPECHECKER):
     from ._base import *
     from ._d1 import *
     from ._d2 import *