{ "info": { "author": "Emin Martinian", "author_email": "emin.martinian@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Developers", "Programming Language :: Python :: 3" ], "description": "Introduction\n============\n\nThe ``pyfinite`` package is a python package for dealing with finite\nfields and related mathematical operations. Also included is a generic\nmatrix package for doing matrix operations over generic fields. As an\nillustration a Reed-Solomon erasure correcting code implementation is\nprovided using these tools.\n\nRoughly speaking a \"field\" is a mathematical space where consistent\naddition, subtraction, multiplication, and division operations are\ndefined. A \"finite field\" is a field where the number of elements is\nfinite. Perhaps the most familiar finite field is the Boolean field\nwhere the elements are 0 and 1, addition (and subtraction) correspond to\nXOR, and multiplication (and division) work as normal for 0 and 1.\n\nMore complicated finite fields are useful and interesting for\ncryptography and erasure correcting codes.\n\nUsage\n=====\n\nAfter you install via something like ``pip install pyfinite``, the best\nway to get started is to look at the doctest examples in the following\nfiles:\n\n- ``ffield.py``: See docstring for ``FField`` and ``FElement`` classes.\n\n - This shows you how to work with finite fields.\n\n- ``genericmatrix.py``: See docstring for ``GenericMatrix`` class.\n\n - This shows you how to do matrix operations on a generic field.\n\n- ``rs_code.py``: See docstring for ``RSCode`` class.\n\n - This shows you how to do Reed-Solomon erasure correcting codes.\n\n- ``file_ecc.py``: See the top-level docstring for the ``file_ecc``\n module.\n\n - Shows you how to encode a file into multiple pieces and decode\n from a subset of those pieces.\n\nFor example, after you install ``pyfinite`` and start the python\ninterpreter, do something like the following to see help on finite\nfields:\n\n.. code:: python\n\n >>> from pyfinite import ffield\n >>> help(ffield.FField)\n\nor if you want to dive right in, you can try something like the\nfollowing:\n\n.. code:: python\n\n >>> from pyfinite import ffield\n >>> F = ffield.FField(5) # create the field GF(2^5)\n >>> a = 7 # field elements are denoted as integers from 0 to 2^5-1\n >>> b = 15\n >>> F.ShowPolynomial(a) # show the polynomial representation of a\n 'x^2 + x^1 + 1'\n >>> c = F.Multiply(a,b) # multiply a and b modulo the field generator\n >>> c\n 8\n >>> F.ShowPolynomial(c)\n 'x^3'\n\nAlternatively, you can jump into the ``genericmatrix.py`` package with\nsomething like:\n\n.. code:: python\n\n >>> import genericmatrix\n >>> v = genericmatrix.GenericMatrix((3,3))\n >>> v.SetRow(0,[0.0, -1.0, 1.0])\n >>> v.SetRow(1,[1.0, 1.0, 1.0])\n >>> v.SetRow(2,[1.0, 1.0, -1.0])\n >>> v\n \n >>> vi = v.Inverse()\n\nThen for some real fun, you can try experimenting with generic matrix\noperations on elements of a finite field! The nice thing about the\n``genericmatrix`` module is that it only relies on the standard python\narithmetic operators so you can use it for anything with sane ``+``,\n``-``, ``*``, and ``/`` operators. See the help on ``genericmatrix`` for\nmore info.\n\nFinally, if you just want erasure correction, see the docs for the\n``rs_code`` and ``file_ecc`` modules via something like\n\n.. code:: python\n\n >>> import rs_code, file_ecc\n >>> help(file_ecc)\n >>> help(rs_code)\n\nFuture work\n===========\n\nThis code was written many years ago and hosted on an old MIT web site\nunder the name ``py_ecc`` before being moved to github. It is in need of\nsome love. In particular, it could use:\n\n1. Reworking to fix pep8/pylint warnings and generally better python\n style.\n2. More documentation.\n3. More examples.\n4. Travis setup to verify doctests in both python2 and python3.\n\n - These have been manually verified but it would be nice to have a\n setup which can run tests on multiple versions of python in an\n automated way.\n\nTo help or contribute please see the main project site at\nhttps://github.com/emin63/pyfinite.\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://github.com/emin63/pyfinite", "keywords": "nosql persistence database", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "pyfinite", "package_url": "https://pypi.org/project/pyfinite/", "platform": "", "project_url": "https://pypi.org/project/pyfinite/", "project_urls": { "Homepage": "http://github.com/emin63/pyfinite" }, "release_url": "https://pypi.org/project/pyfinite/1.7/", "requires_dist": null, "requires_python": "", "summary": "Finite field operations and erasure correction codes.", "version": "1.7" }, "last_serial": 4614957, "releases": { "1.5": [ { "comment_text": "", "digests": { "md5": "881b86ec5e5d54803fa93c702370c7eb", "sha256": "2a59c6d98e4f05464600eae1d1f3822409c91358624c0c8bf4c49e102f5a882c" }, "downloads": -1, "filename": "pyfinite-1.5.tar.gz", "has_sig": false, "md5_digest": "881b86ec5e5d54803fa93c702370c7eb", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 23763, "upload_time": "2018-01-04T03:36:12", "url": "https://files.pythonhosted.org/packages/94/e5/ef9677175556e9612f7cdaa4501b46826a7e07f464e78f929d983dcfeb85/pyfinite-1.5.tar.gz" } ], "1.6": [ { "comment_text": "", "digests": { "md5": "bbea142dcf0c9a90ed571a71cae99e01", "sha256": "8b1b515320604c0b8079883c4196648744cb7b4168333d4d03ddb166dd2528c0" }, "downloads": -1, "filename": "pyfinite-1.6.tar.gz", "has_sig": false, "md5_digest": "bbea142dcf0c9a90ed571a71cae99e01", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 24740, "upload_time": "2018-10-30T19:03:29", "url": "https://files.pythonhosted.org/packages/e8/93/78c68e5bfd882a52ac571669e3ac0b7609a64e0a562646cd763a15adee01/pyfinite-1.6.tar.gz" } ], "1.7": [ { "comment_text": "", "digests": { "md5": "9d16f87c2790aca335217eda419e7e7a", "sha256": "f3cf8daa0f3a5556b8e11008a4c8fd5bf9a60f97dbebe6736737774ccecea39e" }, "downloads": -1, "filename": "pyfinite-1.7.tar.gz", "has_sig": false, "md5_digest": "9d16f87c2790aca335217eda419e7e7a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 24866, "upload_time": "2018-12-19T03:45:04", "url": "https://files.pythonhosted.org/packages/ca/d3/c836cdb45006961c7917572d9673a0bd9e9e241df264cccca96cbbca1221/pyfinite-1.7.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "9d16f87c2790aca335217eda419e7e7a", "sha256": "f3cf8daa0f3a5556b8e11008a4c8fd5bf9a60f97dbebe6736737774ccecea39e" }, "downloads": -1, "filename": "pyfinite-1.7.tar.gz", "has_sig": false, "md5_digest": "9d16f87c2790aca335217eda419e7e7a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 24866, "upload_time": "2018-12-19T03:45:04", "url": "https://files.pythonhosted.org/packages/ca/d3/c836cdb45006961c7917572d9673a0bd9e9e241df264cccca96cbbca1221/pyfinite-1.7.tar.gz" } ] }