<img src="https://gitlab.com/thucyd-dev/thucyd/raw/master/images/thucyd-tile-logo.1500px.png" alt="thucyd-logo" height="150">
# Advanced Eigenanalysis
[](https://gitlab.com/thucyd-dev/thucyd/pipelines)
[](https://gitlab.com/thucyd-dev/thucyd/commits/master)
[](https://gitlab.com/thucyd-dev/thucyd/blob/master/LICENSE)
[](https://github.com/psf/black)
[](https://pypi.python.org/pypi/thucyd)
[](https://www.numpy.org/)
[](https://pypi.python.org/pypi/thucyd)
[](https://anaconda.org/conda-forge/thucyd)
## What is `thucyd`?
`thucyd` (thoo'-sid) delivers a reference implementation of advanced eigenanalysis tools. When more performant libraries are created (elsewhere) then they can use this version as a golden source.
See [A consistently oriented basis for eigenanalysis](https://link.springer.com/article/10.1007/s41060-020-00227-z) (2020) in the _International Journal of Data Science and Analytics_ and [A Consistently Oriented Basis for Eigenanalysis: Improved Directional Statistics](https://arxiv.org/abs/2402.08139) (2024) in _arXiv_ for details of the functions provided in `thucyd`.
## Package Installation
The two package hosts for `thucyd` are [PyPi](https://pypi.org/project/thucyd/) and [Conda-Forge](). The packages are identical and the only difference is the means of delivery. From PyPi, use `pip`,
```bash
$ pip install thucyd
```
and from Conda-Forge use `conda`:
```bash
$ conda install -c conda-forge thucyd
```
Once installed, the package is importable to Python:
```python
>>> import thucyd
```
A quick example call to the `eigen` subpackage would be
```python
>>> import numpy as np
>>> V = np.eye(3).dot(np.diag([1., -1., 1.]))
>>> E = np.arange(3)[::-1]
>>> Vor, Eor, signs, thetas, _ = thucyd.eigen.orient_eigenvectors(V, E)
>>> Vor
array([[1., 0., 0.],
[0., 1., 0.],
[0., 0., 1.]])
>>> signs
array([ 1., -1., 1.])
```
## Package Dependency
The only dependencies `thucyd` has at this time is on [python >= 3.7](https://www.python.org/) and [numpy >= 1.23](https://www.numpy.org/).
## About `thucyd`
[Thucydides](https://en.wikipedia.org/wiki/Thucydides) was the first Western writer and historian who applied scientific principles to the recording of Western history. Although Herodotus, who predates Thucydides by less than a generation, started the transformation away from the epic poetry enshrined by Homer to a more objective record, it was Thucydides who engaged in inquiry and cross validation of all accounts in his History of the Peloponnesian Wars.
## Buell Lane Press
[Buell Lane Press](https://buell-lane-press.co) is the package sponsor.
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/thucyd-dev/thucyd",
"name": "thucyd",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "eigenanalysis",
"author": "Jay Damask",
"author_email": "jaydamask@buell-lane-press.co",
"download_url": "https://files.pythonhosted.org/packages/fa/3e/483aaa33445cffba9924ec7697dc893cf4755ef2951c4b6336aafe138d05/thucyd-0.2.7.tar.gz",
"platform": null,
"description": "<img src=\"https://gitlab.com/thucyd-dev/thucyd/raw/master/images/thucyd-tile-logo.1500px.png\" alt=\"thucyd-logo\" height=\"150\"> \n\n# Advanced Eigenanalysis \n\n[](https://gitlab.com/thucyd-dev/thucyd/pipelines)\n[](https://gitlab.com/thucyd-dev/thucyd/commits/master)\n[](https://gitlab.com/thucyd-dev/thucyd/blob/master/LICENSE)\n[](https://github.com/psf/black)\n[](https://pypi.python.org/pypi/thucyd)\n[](https://www.numpy.org/)\n[](https://pypi.python.org/pypi/thucyd)\n[](https://anaconda.org/conda-forge/thucyd)\n\n## What is `thucyd`?\n\n`thucyd` (thoo'-sid) delivers a reference implementation of advanced eigenanalysis tools. When more performant libraries are created (elsewhere) then they can use this version as a golden source. \n\nSee [A consistently oriented basis for eigenanalysis](https://link.springer.com/article/10.1007/s41060-020-00227-z) (2020) in the _International Journal of Data Science and Analytics_ and [A Consistently Oriented Basis for Eigenanalysis: Improved Directional Statistics](https://arxiv.org/abs/2402.08139) (2024) in _arXiv_ for details of the functions provided in `thucyd`.\n\n\n## Package Installation\n\nThe two package hosts for `thucyd` are [PyPi](https://pypi.org/project/thucyd/) and [Conda-Forge](). The packages are identical and the only difference is the means of delivery. From PyPi, use `pip`,\n\n```bash\n$ pip install thucyd\n```\n\nand from Conda-Forge use `conda`:\n\n```bash\n$ conda install -c conda-forge thucyd\n```\n\nOnce installed, the package is importable to Python:\n\n```python\n>>> import thucyd\n```\n\nA quick example call to the `eigen` subpackage would be\n\n```python\n>>> import numpy as np\n>>> V = np.eye(3).dot(np.diag([1., -1., 1.]))\n>>> E = np.arange(3)[::-1]\n>>> Vor, Eor, signs, thetas, _ = thucyd.eigen.orient_eigenvectors(V, E)\n>>> Vor\narray([[1., 0., 0.],\n [0., 1., 0.],\n [0., 0., 1.]])\n>>> signs\narray([ 1., -1., 1.])\n```\n\n\n## Package Dependency\n\nThe only dependencies `thucyd` has at this time is on [python >= 3.7](https://www.python.org/) and [numpy >= 1.23](https://www.numpy.org/). \n\n\n## About `thucyd`\n\n[Thucydides](https://en.wikipedia.org/wiki/Thucydides) was the first Western writer and historian who applied scientific principles to the recording of Western history. Although Herodotus, who predates Thucydides by less than a generation, started the transformation away from the epic poetry enshrined by Homer to a more objective record, it was Thucydides who engaged in inquiry and cross validation of all accounts in his History of the Peloponnesian Wars.\n\n\n## Buell Lane Press\n\n[Buell Lane Press](https://buell-lane-press.co) is the package sponsor. \n\n\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "Reference library for advanced eigenanalysis.",
"version": "0.2.7",
"project_urls": {
"Changelog": "https://gitlab.com/thucyd-dev/thucyd/",
"Documentation": "https://gitlab.com/thucyd-dev/thucyd/",
"Homepage": "https://gitlab.com/thucyd-dev/thucyd",
"Issue Tracker": "https://gitlab.com/thucyd-dev/thucyd/issues"
},
"split_keywords": [
"eigenanalysis"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fa3e483aaa33445cffba9924ec7697dc893cf4755ef2951c4b6336aafe138d05",
"md5": "5bb40cec9b19578fb7598ed1d9f5b332",
"sha256": "7cd3c628bef6b6c59d8204524c4a5a3e443fc91591fd061463c04053a0d2ca45"
},
"downloads": -1,
"filename": "thucyd-0.2.7.tar.gz",
"has_sig": false,
"md5_digest": "5bb40cec9b19578fb7598ed1d9f5b332",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 15892,
"upload_time": "2024-04-27T20:28:52",
"upload_time_iso_8601": "2024-04-27T20:28:52.788252Z",
"url": "https://files.pythonhosted.org/packages/fa/3e/483aaa33445cffba9924ec7697dc893cf4755ef2951c4b6336aafe138d05/thucyd-0.2.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-27 20:28:52",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "thucyd-dev",
"gitlab_project": "thucyd",
"lcname": "thucyd"
}
JSON