Rename spacetime module to spacetimelib

.github/workflows/python-package-conda.yml

@@ -17,7 +17,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: conda-incubator/setup-miniconda@v2
         with:
-          activate-environment: spacetime
+          activate-environment: spacetimelib
           environment-file: environment.yaml
           python-version: ${{ matrix.python-version }}
           auto-activate-base: false
@@ -28,7 +28,7 @@ jobs:
       - name: Conda list
         run: conda list
 
-      - name: Build spacetime
+      - name: Build spacetimelib
         shell: bash -el {0}
         run: |
           python setup.py install

README.md

@@ -30,10 +30,16 @@ pip install spacetimelib
 Install Miniconda:
 [instructions](https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html)
 
+Clone SpacetimeLib the repository.
+
+```bash
+https://github.com/kurtamohler/spacetimelib.git && cd spacetimelib
+```
+
 Run the following to create and activate an environment with all dependencies.
 
 ```bash
-conda env create -f environment.yaml -n spacetime && conda activate spacetime
+conda env create -f environment.yaml -n spacetimelib && conda activate spacetimelib
 ```
 
 Then install SpacetimeLib.

doc/source/api-reference.rst

@@ -1,21 +1,21 @@
 API Reference
 =============
 
-.. autofunction:: spacetime.norm_s
+.. autofunction:: spacetimelib.norm_s
 
-.. autofunction:: spacetime.norm2_st
+.. autofunction:: spacetimelib.norm2_st
 
-.. autofunction:: spacetime.velocity_st
+.. autofunction:: spacetimelib.velocity_st
 
-.. autofunction:: spacetime.velocity_s
+.. autofunction:: spacetimelib.velocity_s
 
-.. autofunction:: spacetime.boost
+.. autofunction:: spacetimelib.boost
 
-.. autofunction:: spacetime.boost_velocity_s
+.. autofunction:: spacetimelib.boost_velocity_s
 
-.. autofunction:: spacetime.proper_time_delta
+.. autofunction:: spacetimelib.proper_time_delta
 
-.. autoclass:: spacetime.Worldline
+.. autoclass:: spacetimelib.Worldline
    :members:
 
    .. automethod:: __len__
@@ -26,7 +26,7 @@ API Reference
 
    .. automethod:: __eq__
 
-.. autoclass:: spacetime.Frame
+.. autoclass:: spacetimelib.Frame
    :members:
 
    .. automethod:: __len__

doc/source/concepts.md

@@ -79,7 +79,7 @@ terminology.
 To find the distance between two points, we take the norm of the difference between
 them, and in general, we can take the norm of any vector.
 
-We can use [`spacetime.norm_s`](spacetime.norm_s) to calculate the norm of any
+We can use [`spacetimelib.norm_s`](spacetimelib.norm_s) to calculate the norm of any
 space-vector.
 
 ```python
@@ -93,7 +93,7 @@ space-vector.
 5.0
 ```
 
-We can use [`spacetime.norm2_st`](spacetime.norm2_st) to calculate the square
+We can use [`spacetimelib.norm2_st`](spacetimelib.norm2_st) to calculate the square
 norm of any spacetime-vector. The square norm is more convenient than the norm
 itself, because the square norm of a spacetime-vector can be negative.
 
@@ -145,8 +145,8 @@ vN) / sqrt(1 - norm_s(v)**2)`.
 The squared norm of a spacetime-velocity must always be equal to the negative
 of the speed of light.
 
-SpacetimeLib has the functions [`spacetime.velocity_st`](spacetime.velocity_st)
-and [`spacetime.velocity_s`](spacetime.velocity_s) for converting
+SpacetimeLib has the functions [`spacetimelib.velocity_st`](spacetimelib.velocity_st)
+and [`spacetimelib.velocity_s`](spacetimelib.velocity_s) for converting
 between the two kinds of velocity vectors.
 
 ```python
@@ -212,7 +212,7 @@ constant velocity with respect to each other and which share the same origin.
 If we know the coordinates of some event in one of the frames, we can use the
 [Lorentz transformation](https://en.wikipedia.org/wiki/Lorentz_transformation)
 to find the event's coordinates in the other frame. In SpacetimeLib, the
-[`spacetime.boost`](spacetime.boost) function performs a rotation-free Lorentz
+[`spacetimelib.boost`](spacetimelib.boost) function performs a rotation-free Lorentz
 transformation, also known as a Lorentz boost. A Lorentz boost is just
 a Lorentz transformation in which the two reference frames' corresponding
 spatial dimensions are pointed in the same directions. In other words, the
@@ -221,7 +221,7 @@ rotations.
 
 ### Boost example: Superhuman footrace
 
-Let's look at an example problem that [`spacetime.boost`](spacetime.boost) can
+Let's look at an example problem that [`spacetimelib.boost`](spacetimelib.boost) can
 solve for us. Alice is watching a footrace of superhuman athletes. She stands
 still at the starting line for the whole race, at `x = 0`, and the finish line
 is 10 light-seconds away from her, at `x = 10`. The race begins at time `t = 0`
@@ -232,7 +232,7 @@ reaches the finish line at `t = (10 / 0.8) = 12.5` seconds.
 In Alice's frame, the coordinates of the event when Bob passes the finish line
 are given by the vector `(12.5, 10)`. But what are the coordinates of this same
 event from Bob's perspective? Let's solve this with
-[`spacetime.boost`](spacetime.boost).  We'll plug in the coordinates of the
+[`spacetimelib.boost`](spacetimelib.boost).  We'll plug in the coordinates of the
 event in Alice's reference frame and boost it by Bob's velocity, `0.8`, to get
 the coordinates of the event in Bob's reference frame.
 

doc/source/installation.md

@@ -13,7 +13,7 @@ git clone https://github.com/kurtamohler/spacetimelib.git && cd spacetimelib
 Create conda environment.
 
 ```bash
-conda env create -f environment.yaml -n spacetime && conda activate spacetime
+conda env create -f environment.yaml -n spacetimelib && conda activate spacetimelib
 ```
 
 Install SpacetimeLib.
@@ -27,7 +27,7 @@ pip install -e .
 To access SpacetimeLib, import it into your Python code:
 
 ```python
->>> import spacetime as st
+>>> import spacetimelib as st
 ```
 
 Shorten the imported name to `st` for better code readability, but you can just

environment.yaml

@@ -15,3 +15,4 @@ dependencies:
     - matplotlib
     - perfplot
     - build
+    - twine

examples/clock_grid.py

@@ -2,7 +2,7 @@
 import pygame
 import numpy as np
 
-from spacetime import Frame, boost, boost_velocity_s, Worldline
+from spacetimelib import Frame, boost, boost_velocity_s, Worldline
 
 rest_frame = Frame()
 

pyproject.toml

@@ -1,7 +1,6 @@
 [build-system]
 requires = [
   "setuptools>=61.0",
-  "numpy",
   "sphinx",
   "myst-parser",
   "myst-nb",
@@ -23,6 +22,9 @@ classifiers = [
   "License :: OSI Approved :: MIT License",
   "Operating System :: OS Independent",
 ]
+dependencies = [
+  'numpy',
+]
 
 [project.urls]
 "Homepage" = "https://github.com/kurtamohler/spacetimelib"

setup.py

@@ -10,7 +10,7 @@
 with open('LICENSE') as f:
    license = f.read()
 
-name = 'spacetime'
+name = 'spacetimelib'
 version = '0.0'
 release = '0.0.1'
 
@@ -23,7 +23,7 @@
     author_email='kurtamohler@gmail.com',
     url='https://github.com/kurtamohler/spacetimelib',
     # license=license,
-    packages=['spacetime'],
+    packages=['spacetimelib'],
     cmdclass=cmdclass,
     # these are optional and override conf.py settings
     command_options={

spacetime/basic_ops.py → spacetimelib/basic_ops.py

@@ -377,7 +377,7 @@ def velocity_st(vel_s, light_speed=1):
     Spacetime-velocity is traditionally called four-velocity in the context of
     3+1 Minkowski spacetime.
 
-    This is the reverse of :func:`spacetime.velocity_s`.
+    This is the reverse of :func:`spacetimelib.velocity_s`.
 
     Args:
 
@@ -427,7 +427,7 @@ def velocity_s(vel_st):
     '''
     Calculates the space-velocity vector from a spacetime-velocity vector.
 
-    This is the reverse of :func:`spacetime.velocity_st`.
+    This is the reverse of :func:`spacetimelib.velocity_st`.
 
     Args:
 

spacetime/frame.py → spacetimelib/frame.py

@@ -3,7 +3,7 @@
 from itertools import islice
 import re
 
-import spacetime as st
+import spacetimelib as st
 from .error_checking import check, internal_assert, maybe_wrap_index
 
 class Frame:

spacetime/worldline.py → spacetimelib/worldline.py

@@ -1,7 +1,7 @@
 import numpy as np
 import numbers
 
-import spacetime as st
+import spacetimelib as st
 from .error_checking import check, internal_assert
 
 class Worldline:
@@ -482,7 +482,7 @@ def boost(self, boost_vel_s):
             Space-velocity to boost the worldline by.
 
         Returns:
-          :class:`spacetime.Worldline`:
+          :class:`spacetimelib.Worldline`:
         '''
         vertices = st.boost(self._vertices, boost_vel_s)
         past_vel_s = None
@@ -513,7 +513,7 @@ def __add__(self, event_delta):
             Displacements to add to each dimension.
 
         Returns:
-          :class:`spacetime.Worldline`:
+          :class:`spacetimelib.Worldline`:
         '''
         event_delta = np.asarray(event_delta)
         check(event_delta.shape == self._vertices[0].shape, ValueError, lambda: (
@@ -537,7 +537,7 @@ def __sub__(self, event_delta):
             Displacements to subtract from each dimension.
 
         Returns:
-          :class:`spacetime.Worldline`:
+          :class:`spacetimelib.Worldline`:
         '''
         return self + (-event_delta)
 
@@ -548,7 +548,7 @@ def __eq__(self, other):
 
         Args:
 
-          other (:class:`spacetime.Worldline`):
+          other (:class:`spacetimelib.Worldline`):
             Other worldline
 
         Returns:

tests/test_spacetime.py

@@ -1,4 +1,4 @@
-import spacetime as st
+import spacetimelib as st
 import numpy as np
 import unittest
 from itertools import product
@@ -28,7 +28,7 @@ def check_boost_velocity_1D(v, u):
     u = np.array(u)
     return (u - v) / (1 - u * v)
 
-class SpacetimeTestSuite(unittest.TestCase):
+class SpacetimelibTestSuite(unittest.TestCase):
 
     def test_norm_s(self):
         test_sizes = [
@@ -403,7 +403,7 @@ def test_boost_velocity_1D_random(self):
 
         self.assertTrue(np.isclose(u_out, u_out_check).all())
 
-    # Test `spacetime.boost` with lots of different input shapes
+    # Test `spacetimelib.boost` with lots of different input shapes
     def test_boost_shapes(self):
         input_shapes = [
             # frame_v_shape, x_shape, u_shape, x_out_shape_check, u_out_shape_check