Guan Codes
A simple package for generating Gray and Guan codes.
Summary
Getting Started
So far, to get the project one only needs to download it from the repository (or any other source).
It's also possible to download it as a package with
pip install guancodes
which will download the package from pypi.
Prerequisites
To run the scripts there will be needed some version of Python. During the development I'm using 3.8, but I believe that it will also work just fine with some earlier or newer version (at least for now).
In some places I use typing package, that's why 3.8 version is desirable.
Code style
Throughout this work PEP-8 will be used. There are several cases where this may go south.
- In some versions of the code matrices may be denoted by capital letters (as in standard mathematical notation). In order to be more PEP-friendly I'll try to use prefix m_ instead of capital letters, e.g. m_u would be the equivalent of U. Alternatively explicit use of mathematical notation is also acceptable.
Running the tests
Just run all test in tests folder with pytest.
- Note that (for now) there are no unit tests. Just simple sanity check of returned results.
Versioning
I'll use SemVer for versioning and try to keep track of the version in the tags.
Authors
- Tomasz Rybotycki
- Billie Thompson - Provided README Template
License
This project is licensed under the Apache License, v.2.0. See the LICENSE.md file for details.
Acknowledgments
- CTP PAS - This project was done during my Ph.D. at CTP PAS.
1 maintainer
Metadata
1 maintainer
Release files for guancodes 0.0.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| guancodes-0.0.3.tar.gz | 7.3 kB | Without provenance | Details for guancodes-0.0.3.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| guancodes-0.0.3-py3-none-any.whl | Python 3 | none | any | Details for guancodes-0.0.3-py3-none-any.whl |
Total release size: 15.2 kB
Release files / guancodes-0.0.3.tar.gz
| Download URL | guancodes-0.0.3.tar.gz |
|---|---|
| Size | 7.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d3d6f6b2568455028187f7f14bd9852dc58a902233c170aa91e7965182068806
|
|
BLAKE2b-256 checksum How to use checksums |
865f6fdb9974ddb5c72099db37a93deb61a25c0dd7a8ad250bad736299293752
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.0 CPython/3.8.8
|
Release files / guancodes-0.0.3-py3-none-any.whl
| Download URL | guancodes-0.0.3-py3-none-any.whl |
|---|---|
| Size | 7.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f29fc700e7bd9132c0b39756dcba1d90dde14869c29af8a30bb71d3871cdd4a1
|
|
BLAKE2b-256 checksum How to use checksums |
dc99ca9fb70276801ac3d57ea2044d3e67bf340402739b63ffb8a4f567b8a211
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.0 CPython/3.8.8
|
Security for guancodes 0.0.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
