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 contains a lot of functions for faster development.

make install

make pre-commit-install

make polish-codestyle

# or use synonym
make formatting

make check-codestyle

make test

make lint

make check-codestyle && make test && make check-safety

make pycache-remove

make build-remove

make dsstore-remove

make mypycache-remove

make cleanup

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.

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.

This project uses the BSD-3-Clause license. See LICENSE for more details.

@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}}
}

This project was generated with python-package-template