nsimplex


Namensimplex JSON
Version 0.0.1 PyPI version JSON
download
home_pagehttps://github.com/killiansheriff/simplex
SummaryA python package that implements the geometric object of a simplex.
upload_time2024-03-13 23:44:43
maintainer
docs_urlNone
authorKillian Sheriff
requires_python
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Simplex 
![PyPI Version](https://img.shields.io/pypi/v/nsimplex.svg) ![PyPI Downloads](https://static.pepy.tech/badge/nsimplex)

A python package that implements the geometric object of a [simplex](https://en.wikipedia.org/wiki/Simplex).

## Usage 
Here is an example on how to get the mapping from barycentric coordinates (``concentrations``) to cartesian coordinates (``coords``) for a ``n_dim = 2`` for motifs with 12 atoms in their first coordination shell. ``generators`` return the unique set of concentration of the sorted possible concentrations, ``count`` is their multiplicities. This example can be found in the ``examples/`` folder. 

```python
import simplex as sp 

triangle = sp.Simplex(n_dim=2, edge_length=1, nneigh=12)
concentrations, coords = triangle.get_mapping()
generators, counts = triangle.get_generators(concentrations)
```

## Installation
For a standalone Python package or Conda environment, please use:
```bash
pip install --user simplex
```

If you want to install the lastest git commit, please replace ``simplex`` by ``git+https://github.com/killiansheriff/simplex.git``.

## Contact
If any questions, feel free to contact me (ksheriff at mit dot edu).

## References & Citing 
If you use this repository in your work, please cite:

```
@article{TOBEUPDATED,
  title={TOBEUPDATED},
  author={Sheriff, Killian and Cao, Yifan and Freitas, Rodrigo},
  journal={arXiv preprint TOBEUPDATED},
  year={2024}
}
```

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/killiansheriff/simplex",
    "name": "nsimplex",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "",
    "author": "Killian Sheriff",
    "author_email": "ksheriff@mit.edu",
    "download_url": "https://files.pythonhosted.org/packages/50/34/e38106ca19426e63f3f23b0fa94114cd2c81fc50739b6e286a00640def3f/nsimplex-0.0.1.tar.gz",
    "platform": null,
    "description": "# Simplex \n![PyPI Version](https://img.shields.io/pypi/v/nsimplex.svg) ![PyPI Downloads](https://static.pepy.tech/badge/nsimplex)\n\nA python package that implements the geometric object of a [simplex](https://en.wikipedia.org/wiki/Simplex).\n\n## Usage \nHere is an example on how to get the mapping from barycentric coordinates (``concentrations``) to cartesian coordinates (``coords``) for a ``n_dim = 2`` for motifs with 12 atoms in their first coordination shell. ``generators`` return the unique set of concentration of the sorted possible concentrations, ``count`` is their multiplicities. This example can be found in the ``examples/`` folder. \n\n```python\nimport simplex as sp \n\ntriangle = sp.Simplex(n_dim=2, edge_length=1, nneigh=12)\nconcentrations, coords = triangle.get_mapping()\ngenerators, counts = triangle.get_generators(concentrations)\n```\n\n## Installation\nFor a standalone Python package or Conda environment, please use:\n```bash\npip install --user simplex\n```\n\nIf you want to install the lastest git commit, please replace ``simplex`` by ``git+https://github.com/killiansheriff/simplex.git``.\n\n## Contact\nIf any questions, feel free to contact me (ksheriff at mit dot edu).\n\n## References & Citing \nIf you use this repository in your work, please cite:\n\n```\n@article{TOBEUPDATED,\n  title={TOBEUPDATED},\n  author={Sheriff, Killian and Cao, Yifan and Freitas, Rodrigo},\n  journal={arXiv preprint TOBEUPDATED},\n  year={2024}\n}\n```\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A python package that implements the geometric object of a simplex.",
    "version": "0.0.1",
    "project_urls": {
        "Homepage": "https://github.com/killiansheriff/simplex"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "94da316e7a8b8cd57d56783b512d5bea63e74e5671105e6015add3f23ca23442",
                "md5": "444cc50fdd70cad20302ef1e9315e9d3",
                "sha256": "e56cbf5e94ef0130fea2cd4ddb889edda337ff6dbd8a1b75482c5eff4d3b2a09"
            },
            "downloads": -1,
            "filename": "nsimplex-0.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "444cc50fdd70cad20302ef1e9315e9d3",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 3858,
            "upload_time": "2024-03-13T23:44:42",
            "upload_time_iso_8601": "2024-03-13T23:44:42.713701Z",
            "url": "https://files.pythonhosted.org/packages/94/da/316e7a8b8cd57d56783b512d5bea63e74e5671105e6015add3f23ca23442/nsimplex-0.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5034e38106ca19426e63f3f23b0fa94114cd2c81fc50739b6e286a00640def3f",
                "md5": "77ae5272be43d9ddbb3a703d6bf8e586",
                "sha256": "b2c4804b9dedde4af7c3d1314c8e8a9e9d47bf7abeac5ac284d680f802fdc35a"
            },
            "downloads": -1,
            "filename": "nsimplex-0.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "77ae5272be43d9ddbb3a703d6bf8e586",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 3530,
            "upload_time": "2024-03-13T23:44:43",
            "upload_time_iso_8601": "2024-03-13T23:44:43.869461Z",
            "url": "https://files.pythonhosted.org/packages/50/34/e38106ca19426e63f3f23b0fa94114cd2c81fc50739b6e286a00640def3f/nsimplex-0.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-13 23:44:43",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "killiansheriff",
    "github_project": "simplex",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "nsimplex"
}
        
Elapsed time: 0.25853s