spherical-harmonics-basis 0.0.2__tar.gz

spherical_harmonics_basis-0.0.2/.flake8

@@ -0,0 +1,13 @@
+[flake8]
+max-line-length = 88
+select = C,E,F,W,B,B9
+# ignore:
+# E226 missing whitespace around arithmetic operator
+# W503 Line break occurred before a binary operator
+# W504 line break after binary operator
+# F811 redefinition because of multiple dispatch
+# E731 do not assign a lambda expression, use a def
+ignore = E203, E501, W503, E226, W503, W504, F811, E731
+max-complexity = 10
+exclude = __init__.py,.git,__pycache__,.mypy_cache,.pytest_cache
+per-file-ignores = **/__init__.py:F401,F403

spherical_harmonics_basis-0.0.2/.github/workflows/quality-checks.yaml

@@ -0,0 +1,38 @@
+name: QualityChecks
+
+on: [push]
+
+jobs:
+  check-and-test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11"]
+      fail-fast: false
+
+    name: Python-${{ matrix.python-version }}
+    steps:
+      #----------------------------------------------
+      #       check-out repo and set-up python
+      #----------------------------------------------
+    - uses: actions/checkout@v2
+    - uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+      #----------------------------------------------
+      #       install
+      #----------------------------------------------
+    - name: Install dependencies
+      run: |
+        export LAB_NO_BUILD=1
+        make install
+      #----------------------------------------------
+      #       Linting, formatting, etc (black, isort, flake and mypy)
+      #----------------------------------------------
+    - name: Run lint
+      run: make check
+      #----------------------------------------------
+      #       Tests
+      #----------------------------------------------
+    - name: Run tests
+      run: make test

spherical_harmonics_basis-0.0.2/.gitignore

@@ -0,0 +1,246 @@
+# Python
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+
+# Pycharm
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/artifacts
+# .idea/compiler.xml
+# .idea/jarRepositories.xml
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+# *.iml
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser
+
+# Configuration
+.idea/
+
+
+# macOS
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk

spherical_harmonics_basis-0.0.2/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

spherical_harmonics_basis-0.0.2/Makefile

@@ -0,0 +1,55 @@
+.PHONY: help install docs format check test check-and-test
+
+
+LIB_NAME = spherical_harmonics
+TESTS_NAME = tests
+LINT_NAMES = src/$(LIB_NAME) $(TESTS_NAME)
+TYPE_NAMES = src/$(LIB_NAME)
+SUCCESS='\033[0;32m'
+UNAME_S = $(shell uname -s)
+
+# the --per-file-ignores are to ignore "unused import" warnings in __init__.py files (F401)
+# the F403 ignore in gpflux/__init__.py allows the `from .<submodule> import *`
+LINT_FILE_IGNORES = "src/$(LIB_NAME)/__init__.py:F401,F403"
+
+
+help: ## Shows this help message
+	# $(MAKEFILE_LIST) is set by make itself; the following parses the `target:  ## help line` format and adds color highlighting
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-24s\033[0m %s\n", $$1, $$2}'
+
+
+install:  ## Install repo for developement
+	@echo "\n=== pip install package with requirements =============="
+	LAB_NO_BUILD=1 pip install backends
+	@echo "\n=== pip install dev requirements ======================"
+	pip install -r requirements.txt
+	@echo "\n=== pip install test requirements ======================"
+	pip install -r dev_requirements.txt
+	pip install -e .
+
+
+format: ## Formats code with `black` and `isort`
+	@echo "\n=== Autoflake =============================================="
+	autoflake --remove-all-unused-imports --recursive \
+			--remove-unused-variables --in-place --exclude=__init__.py \
+			$(LINT_NAMES)
+	@echo "\n=== black =============================================="
+	black $(LINT_NAMES)
+	@echo "\n=== isort =============================================="
+	isort $(LINT_NAMES)
+
+
+check: ## Runs all static checks such as code formatting checks, linting, mypy
+	@echo "\n=== flake8 (linting)===================================="
+	flake8 --statistics --exclude=.ipynb_checkpoints
+	@echo "\n=== black (formatting) ================================="
+	black --check --diff $(LINT_NAMES)
+	@echo "\n=== isort (formatting) ================================="
+	isort --check --diff $(LINT_NAMES)
+	@echo "\n=== mypy (static type checking) ========================"
+	mypy $(TYPE_NAMES)
+
+test: ## Run unit and integration tests with pytest
+	pytest -v --tb=short --durations=10 $(TESTS_NAME)
+
+check-and-test: check test  ## Run pytest and static tests

spherical_harmonics_basis-0.0.2/PKG-INFO

@@ -0,0 +1,134 @@
+Metadata-Version: 2.1
+Name: spherical-harmonics-basis
+Version: 0.0.2
+Summary: Python Implementation of Spherical harmonics in dimension >= 3
+Author-email: Vincent Dutordoir <vd309@cam.ac.uk>
+Description-Content-Type: text/markdown
+Requires-Dist: numpy
+Requires-Dist: scipy
+Project-URL: Source, https://github.com/vdutor/SphericalHarmonics
+
+# Spherical Harmonics
+
+This package implements spherical harmonics in d-dimensions in Python. The spherical harmonics are defined as zonal functions through the Gegenbauer polynomials and a fundamental system of points (see [Dai and Xu (2013)](https://arxiv.org/pdf/1304.2585.pdf), defintion 3.1). The spherical harmonics form a ortho-normal set on the hypersphere. This package implements a greedy algorithm to compute the fundamental set for dimensions up to 20.
+
+The computations of this package can be carried out in either TensorFlow, Pytorch, Jax or NumPy.
+A specific backend can be chosen by simply importing it as follows
+```
+import spherical_harmonics.tensorflow  # noqa
+```
+
+## Example
+
+### 3 Dimensional
+```python
+import tensorflow as tf
+import spherical_harmonics.tensorflow  # run computation in TensorFlow
+
+from spherical_harmonics import SphericalHarmonics
+from spherical_harmonics.utils import l2norm
+
+dimension = 3
+max_degree = 10
+# Returns all the spherical harmonics in dimension 3 up to degree 10.
+Phi = SphericalHarmonics(dimension, max_degree)
+
+x = tf.random.normal((101, dimension))  # Create random points to evaluate Phi
+x = x / tf.norm(x, axis=1, keepdims=True)  # Normalize vectors
+out = Phi(x)  # Evaluate spherical harmonics at `x`
+
+# In 3D there are (2 * degree + 1) spherical harmonics per degree,
+# so in total we have 400 spherical harmonics of degree 20 and smaller.
+num_harmonics = 0
+for degree in range(max_degree):
+    num_harmonics += 2 * degree + 1
+assert num_harmonics == 100
+
+assert out.shape == (101, num_harmonics)
+```
+
+### 4 Dimensional
+
+The setup for 4 dimensional spherical harmonics is very similar to the 3D case. Note that there are more spherical harmonics now of degree smaller than 20.
+
+```python
+import numpy as np
+from spherical_harmonics import SphericalHarmonics
+from spherical_harmonics.utils import l2norm
+
+dimension = 4
+max_degree = 10
+# Returns all the spherical harmonics of degree 4 up to degree 10.
+Phi = SphericalHarmonics(dimension, max_degree)
+
+x = np.random.randn(101, dimension)  # Create random points to evaluation Phi
+x = x / l2norm(x)  # normalize vectors
+out = Phi(x)  # Evaluate spherical harmonics at `x`
+
+# In 4D there are (degree + 1)**2 spherical harmonics per degree,
+# so in total we have 385 spherical harmonics of degree 20 and smaller.
+num_harmonics = 0
+for degree in range(max_degree):
+    num_harmonics += (degree + 1) ** 2
+assert num_harmonics == 385
+
+assert out.shape == (101, num_harmonics)
+```
+
+---
+**NOTE**
+
+The fundamental systems up to dimensions 20 are precomputed and stored in `spherical_harmonics/fundamental_system`. For each dimension we precompute the first amount of spherical harmonics. This means that in each dimension we support a varying number of maximum degree (`max_degree`) and number of spherical harmonics:
+
+| Dimension | Max Degree | Number Harmonics |
+|----------:|-----------:|-----------------:|
+|         3 |         34 |             1156 |
+|         4 |         20 |             2870 |
+|         5 |         10 |            16170 |
+|         6 |          8 |             1254 |
+|         7 |          7 |             1386 |
+|         8 |          6 |             1122 |
+|         9 |          6 |             1782 |
+|        10 |          6 |             2717 |
+|        11 |          5 |             1287 |
+|        12 |          5 |             1729 |
+|        13 |          5 |             2275 |
+|        14 |          5 |             2940 |
+|        15 |          5 |             3740 |
+|        16 |          4 |              952 |
+|        17 |          4 |             1122 |
+|        18 |          4 |             1311 |
+|        19 |          4 |             1520 |
+|        20 |          4 |             1750 |
+
+To precompute a larger fundamental system for a dimension run the following script
+```
+cd spherical_harmonics
+python fundament_set.py
+```
+after specifying the desired options in the file.
+
+---
+
+## Installation
+
+The package is now available on PyPI under the name of `spherical-harmonics-basis`.
+
+Simply run
+```
+pip install spherical-harmonics-basis
+```
+
+
+## Citation
+
+If this code was useful for your research, please consider citing the following [paper](http://proceedings.mlr.press/v119/dutordoir20a/dutordoir20a.pdf):
+```
+@inproceedings{Dutordoir2020spherical,
+  title     = {{Sparse Gaussian Processes with Spherical Harmonic Features}},
+  author    = {Dutordoir, Vincent and Durrande, Nicolas and Hensman, James},
+  booktitle = {Proceedings of the 37th International Conference on Machine Learning (ICML)},
+  date      = {2020},
+}
+```
+