Ortogonal polynomials in the unit sphere
Project description
Polyharmonics
Quick start
Conda package manager is recommended. Create a conda environment.
conda create -n polyharmonics python==3.10
Activate conda environment
conda activate polyharmonics
Install the package
pip install polyharmonics
Then you can run the client using the following command:
polyharmonics --help
Or with Poetry
:
poetry run polyharmonics --help
Makefile usage
Makefile
contains a lot of functions for faster development.
Install all dependencies and pre-commit hooks
Install requirements:
make install
Pre-commit hooks coulb be installed after git init
via
make pre-commit-install
Codestyle and type checks
Automatic formatting uses ruff
.
make polish-codestyle
# or use synonym
make formatting
Codestyle checks only, without rewriting files:
make check-codestyle
Note:
check-codestyle
usesruff
anddarglint
library
Tests with coverage badges
Run pytest
make test
All linters
Of course there is a command to run all linters in one:
make lint
the same as:
make check-codestyle && make test && make check-safety
Cleanup
Delete pycache files
make pycache-remove
Remove package build
make build-remove
Delete .DS_STORE files
make dsstore-remove
Remove .mypycache
make mypycache-remove
Or to remove all above run:
make cleanup
📈 Releases
You can see the list of available releases on the GitHub Releases page.
We follow Semantic Versions specification.
We use Release Drafter
. As pull requests are merged, a draft release is kept up-to-date listing the changes, ready to publish when you’re ready. With the categories option, you can categorize pull requests in release notes using labels.
List of labels and corresponding titles
Label | Title in Releases |
---|---|
enhancement , feature |
🚀 Features |
bug , refactoring , bugfix , fix |
🔧 Fixes & Refactoring |
build , ci , testing |
📦 Build System & CI/CD |
breaking |
💥 Breaking Changes |
documentation |
📝 Documentation |
dependencies |
⬆️ Dependencies updates |
You can update it in release-drafter.yml
.
GitHub creates the bug
, enhancement
, and documentation
labels for you. Dependabot creates the dependencies
label. Create the remaining labels on the Issues tab of your GitHub repository, when you need them.
🛡 License
This project uses the BSD-3-Clause
license. See LICENSE for more details.
📃 Citation
@misc{polyharmonics,
author = {Iván Salido Cobo},
title = {Ortogonal Polynomials in the unit sphere.},
year = {2024},
publisher = {GitHub},
journal = {GitHub repository},
howpublished = {\url{https://github.com/ComicIvans/polyharmonics}}
}
Credits
This project was generated with python-package-template
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for polyharmonics-0.5.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d4016e9977fa25a09caff785796efd549c23f3f71b1eff3275740c671e3d3d48 |
|
MD5 | 3a7ffa434e8cf6fb290cee4331d932e6 |
|
BLAKE2b-256 | aad377a20997aa64f82355e6f2cece33041268ec400b176c5d07020fc0a1513b |