orthax 0.1.0__tar.gz

orthax-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Rory Conlin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

orthax-0.1.0/MANIFEST.in

@@ -0,0 +1,2 @@
+include versioneer.py
+include orthax/_version.py

orthax-0.1.0/PKG-INFO

@@ -0,0 +1,84 @@
+Metadata-Version: 2.1
+Name: orthax
+Version: 0.1.0
+Summary: Orthogonal polynomials with JAX
+Home-page: https://github.com/f0uriest/orthax
+Author: Rory Conlin
+Author-email: wconlin@princeton.edu
+License: MIT
+Project-URL: Issues Tracker, https://github.com/f0uriest/orthax/issues
+Project-URL: Contributing, https://github.com/f0uriest/orthax/blob/master/CONTRIBUTING.rst
+Project-URL: Source Code, https://github.com/f0uriest/orthax/
+Project-URL: Documentation, https://orthax.readthedocs.io/
+Keywords: polynomial orthogonal hermite laguerre legendre chebyshev
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Requires-Python: >=3.8
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: jax<=0.5.0,>=0.3.2
+Requires-Dist: numpy<2.0,>=1.20.0
+
+
+########
+orthax
+########
+|License| |DOI| |Issues| |Pypi|
+
+|Docs| |UnitTests| |Codecov|
+
+``orthax`` is a Python package for working with orthogonal (and other) polynomials in JAX.
+It largely seeks to replicate the functionality of the ``numpy.polynomial`` package,
+through there are some API differences due to limitations of JAX, primarily that
+trailing zeros are not automatically trimmed from series, so you should do that
+manually if it becomes a concern.
+
+For full details of various options see the `Documentation <https://orthax.readthedocs.io/en/latest/>`__
+
+Installation
+============
+
+orthax is installable with ``pip``:
+
+.. code-block:: console
+
+    pip install orthax
+
+
+
+.. |License| image:: https://img.shields.io/github/license/f0uriest/orthax?color=blue&logo=open-source-initiative&logoColor=white
+    :target: https://github.com/f0uriest/orthax/blob/master/LICENSE
+    :alt: License
+
+.. |DOI| image:: https://zenodo.org/badge/709132830.svg
+    :target: https://zenodo.org/doi/10.5281/zenodo.10035983
+    :alt: DOI
+
+.. |Docs| image:: https://img.shields.io/readthedocs/orthax?logo=Read-the-Docs
+    :target: https://orthax.readthedocs.io/en/latest/?badge=latest
+    :alt: Documentation
+
+.. |UnitTests| image:: https://github.com/f0uriest/orthax/actions/workflows/unittest.yml/badge.svg
+    :target: https://github.com/f0uriest/orthax/actions/workflows/unittest.yml
+    :alt: UnitTests
+
+.. |Codecov| image:: https://codecov.io/github/f0uriest/orthax/graph/badge.svg?token=MB11I7WE3I
+    :target: https://codecov.io/github/f0uriest/orthax
+    :alt: Coverage
+
+.. |Issues| image:: https://img.shields.io/github/issues/f0uriest/orthax
+    :target: https://github.com/f0uriest/orthax/issues
+    :alt: GitHub issues
+
+.. |Pypi| image:: https://img.shields.io/pypi/v/orthax
+    :target: https://pypi.org/project/orthax/
+    :alt: Pypi

orthax-0.1.0/README.rst

@@ -0,0 +1,54 @@
+
+########
+orthax
+########
+|License| |DOI| |Issues| |Pypi|
+
+|Docs| |UnitTests| |Codecov|
+
+``orthax`` is a Python package for working with orthogonal (and other) polynomials in JAX.
+It largely seeks to replicate the functionality of the ``numpy.polynomial`` package,
+through there are some API differences due to limitations of JAX, primarily that
+trailing zeros are not automatically trimmed from series, so you should do that
+manually if it becomes a concern.
+
+For full details of various options see the `Documentation <https://orthax.readthedocs.io/en/latest/>`__
+
+Installation
+============
+
+orthax is installable with ``pip``:
+
+.. code-block:: console
+
+    pip install orthax
+
+
+
+.. |License| image:: https://img.shields.io/github/license/f0uriest/orthax?color=blue&logo=open-source-initiative&logoColor=white
+    :target: https://github.com/f0uriest/orthax/blob/master/LICENSE
+    :alt: License
+
+.. |DOI| image:: https://zenodo.org/badge/709132830.svg
+    :target: https://zenodo.org/doi/10.5281/zenodo.10035983
+    :alt: DOI
+
+.. |Docs| image:: https://img.shields.io/readthedocs/orthax?logo=Read-the-Docs
+    :target: https://orthax.readthedocs.io/en/latest/?badge=latest
+    :alt: Documentation
+
+.. |UnitTests| image:: https://github.com/f0uriest/orthax/actions/workflows/unittest.yml/badge.svg
+    :target: https://github.com/f0uriest/orthax/actions/workflows/unittest.yml
+    :alt: UnitTests
+
+.. |Codecov| image:: https://codecov.io/github/f0uriest/orthax/graph/badge.svg?token=MB11I7WE3I
+    :target: https://codecov.io/github/f0uriest/orthax
+    :alt: Coverage
+
+.. |Issues| image:: https://img.shields.io/github/issues/f0uriest/orthax
+    :target: https://github.com/f0uriest/orthax/issues
+    :alt: GitHub issues
+
+.. |Pypi| image:: https://img.shields.io/pypi/v/orthax
+    :target: https://pypi.org/project/orthax/
+    :alt: Pypi

orthax-0.1.0/orthax/__init__.py

@@ -0,0 +1,13 @@
+"""orthax: orthogonal polynomial series with JAX."""
+from . import (
+    _version,
+    chebyshev,
+    hermite,
+    hermite_e,
+    laguerre,
+    legendre,
+    polynomial,
+    polyutils,
+)
+
+__version__ = _version.get_versions()["version"]

orthax-0.1.0/orthax/_version.py

@@ -0,0 +1,21 @@
+
+# This file was generated by 'versioneer.py' (0.19) from
+# revision-control system data, or from the parent directory name of an
+# unpacked source archive. Distribution tarballs contain a pre-generated copy
+# of this file.
+
+import json
+
+version_json = '''
+{
+ "date": "2024-03-03T00:03:51-0500",
+ "dirty": false,
+ "error": null,
+ "full-revisionid": "72c7b9d9b7073bf5f95420d40b4efc0df4fcfbe6",
+ "version": "0.1.0"
+}
+'''  # END VERSION_JSON
+
+
+def get_versions():
+    return json.loads(version_json)