Variants of the Kaczmarz algorithm for solving linear systems.
Project description
Kaczmarz Algorithms
Variants of the Kaczmarz algorithm for solving linear systems in Python.
Installation
Stable Release: pip install kaczmarz-algorithms
Development Head: pip install git+https://github.com/jdmoorman/kaczmarz-algorithms.git
Quick Start
Citing
If you use our work in an academic setting, please cite our paper:
Documentation
TODO: readthedocs For more information, read the docs.
Development
See CONTRIBUTING.md for information related to developing the code.
Additional Optional Setup Steps:
- Make sure the github repository initialized correctly at
https://github.com:jdmoorman/kaczmarz-algorithms.git
- Add branch protections to
master
- To protect from just anyone pushing to
master
- Go to your GitHub repository's settings and under the
Branches
tab, clickAdd rule
and select the settings you believe best. - Recommendations:
- Require pull request reviews before merging
- Require status checks to pass before merging
- To protect from just anyone pushing to
Suggested Git Branch Strategy
master
is for the most up-to-date development, very rarely should you directly commit to this branch. It is recommended to commit to development branches and make pull requests to master.- Your day-to-day work should exist on branches separate from
master
. Even if it is just yourself working on the repository, make a PR from your working branch tomaster
so that you can ensure your commits don't break the development head. GitHub Actions will run on every push to any branch or any pull request from any branch to any other branch. - It is recommended to use "Squash and Merge" commits when committing PR's. It makes each set of changes to
master
atomic and as a side effect naturally encourages small well defined PR's.
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
kaczmarz-algorithms-0.1.1.tar.gz
(12.6 kB
view hashes)
Built Distribution
Close
Hashes for kaczmarz-algorithms-0.1.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bb4dfa858d83e527890edaed7af41dfffaec97d0bc5327f19419b1c431d12af8 |
|
MD5 | dd5819a32f7b439d920b5c3e105a7f24 |
|
BLAKE2b-256 | a33e54531fc97fcf2a502f87dd0fa809a372acc1e5111a9f09098dfb21518fca |
Close
Hashes for kaczmarz_algorithms-0.1.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 85f45def9b018f2069f1a329a94800e974bc5aa7e013397e7f8255802d223da6 |
|
MD5 | f22bd980082565cc64441b37a4dfa077 |
|
BLAKE2b-256 | 58112290fba00dd32860e703442608b3bb0e7527931e87056222778eceef9110 |