Merge branch 'release-v0.1.0-alpha' into 'main'

release v0.1.0-alpha

See merge request interpol/minterpy!26

.gitignore

@@ -0,0 +1,182 @@
+# 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/
+
+# setuptools_scm
+src/*/version.py
+
+# Mac OS stuff
+.DS_Store
+
+# BibTeX (JabRef)
+*.bib.bak
+*.bib.sav
+
+# JETBRAINS
+
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm
+
+*.iml
+
+## Directory-based project format:
+.idea/
+# if you remove the above rule, at least ignore the following:
+
+# User-specific stuff:
+# .idea/workspace.xml
+# .idea/tasks.xml
+# .idea/dictionaries
+# .idea/shelf
+
+# Sensitive or high-churn files:
+# .idea/dataSources.ids
+# .idea/dataSources.xml
+# .idea/sqlDataSources.xml
+# .idea/dynamic.xml
+# .idea/uiDesigner.xml
+
+# Gradle:
+# .idea/gradle.xml
+# .idea/libraries
+
+# Mongo Explorer plugin:
+# .idea/mongoSettings.xml
+
+## File-based project format:
+*.ipr
+*.iws

.pre-commit-config.yaml

@@ -0,0 +1,54 @@
+repos:
+- repo: https://github.com/psf/black
+  rev: 20.8b1
+  hooks:
+  - id: black
+
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v3.4.0
+  hooks:
+  - id: check-added-large-files
+  - id: check-case-conflict
+  - id: check-merge-conflict
+  - id: check-symlinks
+  - id: check-yaml
+  - id: debug-statements
+  - id: end-of-file-fixer
+  - id: mixed-line-ending
+  - id: requirements-txt-fixer
+  - id: trailing-whitespace
+
+- repo: https://github.com/PyCQA/isort
+  rev: 5.8.0
+  hooks:
+  - id: isort
+
+- repo: https://github.com/asottile/pyupgrade
+  rev: v2.12.0
+  hooks:
+  - id: pyupgrade
+    args: ["--py36-plus"]
+
+- repo: https://github.com/asottile/setup-cfg-fmt
+  rev: v1.17.0
+  hooks:
+  - id: setup-cfg-fmt
+
+- repo: https://github.com/pycqa/flake8
+  rev: 3.9.0
+  hooks:
+  - id: flake8
+    exclude: ^(docs/conf.py|tests/)
+    additional_dependencies: [flake8-bugbear, flake8-print,flake8-docstrings,pep8-naming]
+
+- repo: https://github.com/pre-commit/mirrors-mypy
+  rev: v0.812
+  hooks:
+  - id: mypy
+    files: src
+
+- repo: https://github.com/mgedmin/check-manifest
+  rev: "0.46"
+  hooks:
+  - id: check-manifest
+    stages: [manual]

.readthedocs.yml

@@ -0,0 +1,21 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Include PDF and ePub
+formats: all
+
+python:
+  version: 3.8
+  install:
+  - method: pip
+    path: .
+    extra_requirements:
+    - docs

AUTHORS.md

@@ -0,0 +1,24 @@
+# Contributors
+
+## Main code development
+- Uwe Hernandez Acosta (HZDR/CASUS) <[email protected]>
+- Sachin Krishnan Thekke Veettil (HZDR/CASUS) <[email protected]>
+- Damar Wicaksono (HZDR/CASUS) <[email protected]>
+
+
+## Mathematical foundation
+- Michael Hecht(HZDR/CASUS) <[email protected]>
+
+## Former Members and Contributions
+- Jannik Michelfeit
+- Nico Hoffman (HZDR)
+- Steve Schmerler (HZDR)
+- Vidya Chandrashekar (TU Dresden)
+
+## Acknowledgement
+- Klaus Steiniger (HZDR)
+- Patrick Stiller (HZDR)
+- Matthias Werner (HZDR)
+- Krzysztof Gonciarz (MPI-CBG,CSBD)
+- Attila Cangi (HZDR/CASUS)
+- Michael Bussmann (HZDR/CASUS)

CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+# Version 0.1.0-alpha
+This is the initial alpha release of `minterpy`. It contains general structures to perform the polynomial interpolation task in multiple dimensions:
+* Multivariate polynomial bases (ABC + concrete implementations)
+* Base transformations
+* Interpolation schemes
+
+This code is still highly experimental and there is no issuance, that neither everything works as expected, nor if further releases will break the current API.