duncandc · smhr · Aug 16, 2022 · Aug 16, 2022 · Aug 16, 2022 · Sep 8, 2022
diff --git a/README.md b/README.md
@@ -24,7 +24,12 @@ In order to use the functions in this package, you will need the following pytho
 
 ## Installation
 
-Place this directory in your PYTHONPATH.  The various functions can then be imported as, e.g.:  
+It could be installable as:
+
+```
+pip install --user .
+```
+The various functions can then be imported as, e.g.:  
 
 ```
 from rotations import rotate_vector_collection
@@ -44,4 +49,4 @@ pytest
 
 
 contact:
-[email protected]
+[email protected]
diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1,7 @@
+# Packages required for basic usage of `rotations` package
+numpy
+astropy
+
+# Packages required for unit tests
+nose
+coverage
diff --git a/rotations/README.md b/rotations/README.md
@@ -0,0 +1,47 @@
+# Rotations
+
+This package contains functions to rotate collections of 2D and 3D vectors.
+
+Some of the functionality of this package is taken from the [Halotools](https://halotools.readthedocs.io/en/latest/) utilities sudmodule, reproduced here for convenience.    
+
+
+## Description
+
+This package contains tools to perform:
+
+* rotations of 3D vectors,
+* rotations of 2D vectors,
+* and monte carlo rotations of 2D and 3D vectors.
+
+
+## Requirements
+
+In order to use the functions in this package, you will need the following python packages installed:
+
+* numpy
+* astropy
+
+
+## Installation
+
+Place this directory in your PYTHONPATH.  The various functions can then be imported as, e.g.:  
+
+```
+from rotations import rotate_vector_collection
+```  
+
+or for 2- and 3-D specific functions,
+
+```
+from rotations.rotations3d import rotation_matrices_from_vectors
+``` 
+
+You can run the testing suite for this package using the [pytest](https://docs.pytest.org/en/latest/) framework by executing the following command in the package directory:
+
+```
+pytest
+```
+
+
+contact:
+[email protected]
diff --git a/__init__.py → rotations/__init__.py b/__init__.py → rotations/__init__.py
diff --git a/mcrotations.py → rotations/mcrotations.py b/mcrotations.py → rotations/mcrotations.py
@@ -8,10 +8,10 @@
                         unicode_literals)
 import numpy as np
 from astropy.utils.misc import NumpyRNGContext
-from vector_utilities import *
-from rotate_vector_collection import rotate_vector_collection
-from rotations2d import rotation_matrices_from_angles as rotation_matrices_from_angles_2d
-from rotations3d import rotation_matrices_from_angles as rotation_matrices_from_angles_3d
+from .vector_utilities import *
+from .rotate_vector_collection import rotate_vector_collection
+from .rotations2d import rotation_matrices_from_angles as rotation_matrices_from_angles_2d
+from .rotations3d import rotation_matrices_from_angles as rotation_matrices_from_angles_3d
 
 
 __all__=['random_rotation_3d',

diff --git a/rotate_vector_collection.py → rotations/rotate_vector_collection.py b/rotate_vector_collection.py → rotations/rotate_vector_collection.py
diff --git a/rotations2d.py → rotations/rotations2d.py b/rotations2d.py → rotations/rotations2d.py
diff --git a/rotations3d.py → rotations/rotations3d.py b/rotations3d.py → rotations/rotations3d.py
diff --git a/tests/__init__.py → rotations/tests/__init__.py b/tests/__init__.py → rotations/tests/__init__.py
diff --git a/tests/test_2d.py → rotations/tests/test_2d.py b/tests/test_2d.py → rotations/tests/test_2d.py
diff --git a/tests/test_3d.py → rotations/tests/test_3d.py b/tests/test_3d.py → rotations/tests/test_3d.py
diff --git a/tests/test_mcrotations.py → rotations/tests/test_mcrotations.py b/tests/test_mcrotations.py → rotations/tests/test_mcrotations.py
diff --git a/tests/test_rotate_vector_collection.py → ...ns/tests/test_rotate_vector_collection.py b/tests/test_rotate_vector_collection.py → ...ns/tests/test_rotate_vector_collection.py
diff --git a/tests/test_utilities.py → rotations/tests/test_utilities.py b/tests/test_utilities.py → rotations/tests/test_utilities.py
diff --git a/vector_utilities.py → rotations/vector_utilities.py b/vector_utilities.py → rotations/vector_utilities.py
diff --git a/setup.py b/setup.py
@@ -0,0 +1,9 @@
+from setuptools import setup
+
+setup(
+    name='rotations',
+    version='1.0.0',
+    packages=["rotations"],
+    install_requires=["numpy", "astropy"],
+    tests_require=["nose","coverage"],
+)