Merge pull request #7 from FlorianPfaff/structured

Structured repository to make pyRecEst usable as a package

Author: FlorianPfaff

.github/workflows/tests.yml

@@ -31,9 +31,12 @@ jobs:
       run: |
         ls -al
         python -c 'import sys; print(sys.version_info[:])'
+    
     - name: Run tests
       shell: bash -l {0}
-      run: pytest -v --strict-config --junitxml=junit_test_results.xml
+      env: 
+          PYTHONPATH: ${{ github.workspace }}
+      run: pytest --rootdir . -v --strict-config --junitxml=junit_test_results.xml ./pyrecest
 
     - name: Publish test results
       if: always()

pyrecest/__init__.py

@@ -0,0 +1,32 @@
+from .abstract_circular_distribution import AbstractCircularDistribution
+from .abstract_dirac_distribution import AbstractDiracDistribution
+from .abstract_disk_distribution import AbstractDiskDistribution
+from .abstract_distribution import AbstractDistribution
+from .abstract_ellipsoidal_ball_distribution import AbstractEllipsoidalBallDistribution
+from .abstract_hyperhemispherical_distribution import AbstractHyperhemisphericalDistribution
+from .abstract_hypersphere_subset_distribution import AbstractHypersphereSubsetDistribution
+from .abstract_hypersphere_subset_uniform_distribution import AbstractHypersphereSubsetUniformDistribution
+from .abstract_hyperspherical_distribution import AbstractHypersphericalDistribution
+from .abstract_hypertoroidal_distribution import AbstractHypertoroidalDistribution
+from .abstract_periodic_distribution import AbstractPeriodicDistribution
+from .abstract_toroidal_distribution import AbstractToroidalDistribution
+from .abstract_uniform_distribution import AbstractUniformDistribution
+from .bingham_distribution import BinghamDistribution
+from .custom_distribution import CustomDistribution
+from .custom_hemispherical_distribution import CustomHemisphericalDistribution
+from .custom_hyperhemispherical_distribution import CustomHyperhemisphericalDistribution
+from .disk_uniform_distribution import DiskUniformDistribution
+from .ellipsoidal_ball_uniform_distribution import EllipsoidalBallUniformDistribution
+from .fourier_distribution import FourierDistribution
+from .gaussian_distribution import GaussianDistribution
+from .hyperhemispherical_uniform_distribution import HyperhemisphericalUniformDistribution
+from .hyperspherical_mixture import HypersphericalMixture
+from .hyperspherical_uniform_distribution import HypersphericalUniformDistribution
+from .hypertoroidal_wd_distribution import HypertoroidalWDDistribution
+from .hypertoroidal_wn_distribution import HypertoroidalWNDistribution
+from .toroidal_wd_distribution import ToroidalWDDistribution
+from .vmf_distribution import VMFDistribution
+from .vm_distribution import VMDistribution
+from .watson_distribution import WatsonDistribution
+from .wd_distribution import WDDistribution
+from .wn_distribution import WNDistribution

pyrecest/distributions/__init__.py

@@ -1,6 +1,6 @@
 
 import numpy as np
-from abstract_hypertoroidal_distribution import AbstractHypertoroidalDistribution
+from .abstract_hypertoroidal_distribution import AbstractHypertoroidalDistribution
 
 class AbstractCircularDistribution(AbstractHypertoroidalDistribution):
     def __init__(self):
@@ -22,7 +22,7 @@ def cdf_single(x):
         return np.array([cdf_single(x) for x in xa])
 
     def sample_metropolis_hastings(self, n, proposal=None, start_point=None, burn_in=10, skipping=5):
-        from wn_distribution import WNDistribution
+        from .wn_distribution import WNDistribution
         if proposal is None:
             wn = WNDistribution.from_moment(self.trigonometric_moment(1))
             wn.mu = 0

abstract_circular_distribution.py …utions/abstract_circular_distribution.pyabstract_circular_distribution.py renamed to pyrecest/distributions/abstract_circular_distribution.py abstract_circular_distribution.py renamed to pyrecest/distributions/abstract_circular_distribution.py

@@ -1,5 +1,5 @@
 import numpy as np
-from abstract_ellipsoidal_ball_distribution import AbstractEllipsoidalBallDistribution
+from .abstract_ellipsoidal_ball_distribution import AbstractEllipsoidalBallDistribution
 
 class AbstractDiskDistribution(AbstractEllipsoidalBallDistribution):
     # We index it using 2-D Euclidean vectors (is zero everywhere else)

abstract_dirac_distribution.py …ributions/abstract_dirac_distribution.pyabstract_dirac_distribution.py renamed to pyrecest/distributions/abstract_dirac_distribution.py abstract_dirac_distribution.py renamed to pyrecest/distributions/abstract_dirac_distribution.py

@@ -1,6 +1,6 @@
 import numpy as np
 from scipy.special import gamma
-from abstract_distribution import AbstractDistribution
+from .abstract_distribution import AbstractDistribution
 
 
 class AbstractEllipsoidalBallDistribution(AbstractDistribution):

abstract_disk_distribution.py …tributions/abstract_disk_distribution.pyabstract_disk_distribution.py renamed to pyrecest/distributions/abstract_disk_distribution.py abstract_disk_distribution.py renamed to pyrecest/distributions/abstract_disk_distribution.py

@@ -1,7 +1,8 @@
 import warnings
 import numpy as np
 from scipy.optimize import minimize
-from abstract_hypersphere_subset_distribution import AbstractHypersphereSubsetDistribution
+from .abstract_hypersphere_subset_distribution import AbstractHypersphereSubsetDistribution
+
 class AbstractHyperhemisphericalDistribution(AbstractHypersphereSubsetDistribution):
     def mean(self):
         return self.mean_axis()

abstract_distribution.py …t/distributions/abstract_distribution.pyabstract_distribution.py renamed to pyrecest/distributions/abstract_distribution.py abstract_distribution.py renamed to pyrecest/distributions/abstract_distribution.py

@@ -1,7 +1,7 @@
 import numpy as np
-from abstract_periodic_distribution import AbstractPeriodicDistribution
 from scipy.integrate import quad, nquad
 from scipy.special import gamma
+from .abstract_periodic_distribution import AbstractPeriodicDistribution
 
 class AbstractHypersphereSubsetDistribution(AbstractPeriodicDistribution):
     def mean_direction(self):