| Name | coxeter JSON |
| Version |
0.9.0
JSON |
| download |
| home_page | None |
| Summary | Tools for creating and manipulating shapes. |
| upload_time | 2024-09-16 19:28:15 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | BSD 3-Clause License for coxeter Copyright (c) 2015-2024 The Regents of the University of Michigan. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
geometry
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
coxeter
=======
|JOSS|
|ReadTheDocs|
|PyPI|
|conda-forge|
.. |JOSS| image:: https://joss.theoj.org/papers/10.21105/joss.03098/status.svg
:target: https://doi.org/10.21105/joss.03098
.. |ReadTheDocs| image:: https://readthedocs.org/projects/coxeter/badge/?version=latest
:target: http://coxeter.readthedocs.io/en/latest/?badge=latest
.. |PyPI| image:: https://img.shields.io/pypi/v/coxeter.svg
:target: https://pypi.org/project/coxeter/
.. |conda-forge| image:: https://img.shields.io/conda/vn/conda-forge/coxeter.svg
:target: https://anaconda.org/conda-forge/coxeter
Welcome to the documentation for **coxeter**!
The **coxeter** Python library provides tools for working with common geometric objects in two and three dimensions.
Named for the `20th century geometer <https://en.wikipedia.org/wiki/Harold_Scott_MacDonald_Coxeter>`__ best known for his work on polytopes, **coxeter** is especially focused on polygons and polyhedra, but it also support various standard curved shapes such as spheres and ellipsoids.
The package emphasizes working with shapes as mutable objects whose geometric attributes may be accessed using property-based APIs.
Since **coxeter** originally arose to support representations of anisotropic nanoparticles, many shapes support calculations of physical properties (such as form factors and inertia tensors) in addition to purely geometric ones.
However, the package is designed with more general audiences in mind as well, and it aims to support precise calculations of a wide range of geometric quantities that are useful in a number of fields.
Some core features of **coxeter** include:
* Libraries of common shapes to support easy construction.
* Mutable shape objects that can be rescaled in a variety of ways to suit a number of needs.
* Immediate access to geometric properties of shapes via Python properties of shape objects.
* Plotting functionality to make it easy to visualize shapes in both two and three dimensions.
More detailed information on **coxeter**'s features and examples of how to use them may be found in the `documentation <https://coxeter.readthedocs.io/>`__.
.. _installing:
Setup
-----
The recommended methods for installing coxeter are using **pip** or **conda**.
Installation via pip
~~~~~~~~~~~~~~~~~~~~
To install the package from PyPI, execute:
.. code:: bash
pip install coxeter --user
Installation via conda
~~~~~~~~~~~~~~~~~~~~~~
To install the package from conda, first add the **conda-forge** channel:
.. code:: bash
conda config --add channels conda-forge
After the **conda-forge** channel has been added, you can install coxeter by executing
.. code:: bash
conda install coxeter
Installation from source
~~~~~~~~~~~~~~~~~~~~~~~~
Start by executing the following:
.. code:: bash
git clone https://github.com/glotzerlab/coxeter.git
cd coxeter
To install coxeter and other optional dependencies, choose one of the following:
.. code:: bash
pip install . # Install with no additional dependencies
pip install .[tests] # RECOMMENDED: Install with dependencies required to run pytests
pip install .[tests,doc] # Install all dependencies required to develop for coxeter
Requirements
~~~~~~~~~~~~
- Python >= 3.8
- NumPy >= 1.19.0
- SciPy >= 1.0.0
- rowan >= 1.2.0
Testing
-------
The package is currently tested for Python >= 3.8 on Unix-like systems.
Continuous integrated testing is performed using Github actions on these Python versions.
First, install the packages required to test coxeter (if not already done):
.. code:: bash
pip install -r tests/requirements.txt
To run the packaged unit tests, execute the following line from the root of the repository:
.. code:: bash
pytest
To run the packaged unit tests with the coverage module:
.. code:: bash
pytest --cov=coxeter
Building Documentation
----------------------
Documentation for coxeter is written in `reStructuredText <http://docutils.sourceforge.net/rst.html>`__ and compiled using `Sphinx <http://www.sphinx-doc.org/en/master/>`__.
To build the documentation, first install Sphinx and the other required packages:
.. code:: bash
pip install -r doc/requirements.txt
conda install -c conda-forge fresnel
.. warning::
The `fresnel <https://fresnel.readthedocs.io/>`_ package on conda-forge must be used. The PyPI package *fresnel* is different and will not function properly.
You can then use Sphinx to create the actual documentation in either PDF or HTML form by running the following commands:
.. code:: bash
cd doc
make html # For html output
make latexpdf # For a LaTeX compiled PDF file
open build/html/index.html
Support and Contribution
========================
This package is hosted on `GitHub <https://github.com/glotzerlab/coxeter>`_.
Please report any bugs or problems that you find on the `issue tracker <https://github.com/glotzerlab/coxeter/issues>`_.
All contributions to coxeter are welcomed via pull requests!
Raw data
{
"_id": null,
"home_page": null,
"name": "coxeter",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "geometry",
"author": null,
"author_email": "Vyas Ramasubramani <vramasub@umich.edu>, Bradley Dice <bdice@umich.edu>, Jen Bradley <jenbrad@umich.edu>",
"download_url": "https://files.pythonhosted.org/packages/c4/29/b65f708cc5cf373d167811887d086754fd818a6cf3cc6d090733e7d88e92/coxeter-0.9.0.tar.gz",
"platform": null,
"description": "coxeter\n=======\n\n|JOSS|\n|ReadTheDocs|\n|PyPI|\n|conda-forge|\n\n.. |JOSS| image:: https://joss.theoj.org/papers/10.21105/joss.03098/status.svg\n :target: https://doi.org/10.21105/joss.03098\n.. |ReadTheDocs| image:: https://readthedocs.org/projects/coxeter/badge/?version=latest\n :target: http://coxeter.readthedocs.io/en/latest/?badge=latest\n.. |PyPI| image:: https://img.shields.io/pypi/v/coxeter.svg\n :target: https://pypi.org/project/coxeter/\n.. |conda-forge| image:: https://img.shields.io/conda/vn/conda-forge/coxeter.svg\n :target: https://anaconda.org/conda-forge/coxeter\n\nWelcome to the documentation for **coxeter**!\nThe **coxeter** Python library provides tools for working with common geometric objects in two and three dimensions.\nNamed for the `20th century geometer <https://en.wikipedia.org/wiki/Harold_Scott_MacDonald_Coxeter>`__ best known for his work on polytopes, **coxeter** is especially focused on polygons and polyhedra, but it also support various standard curved shapes such as spheres and ellipsoids.\n\nThe package emphasizes working with shapes as mutable objects whose geometric attributes may be accessed using property-based APIs.\nSince **coxeter** originally arose to support representations of anisotropic nanoparticles, many shapes support calculations of physical properties (such as form factors and inertia tensors) in addition to purely geometric ones.\nHowever, the package is designed with more general audiences in mind as well, and it aims to support precise calculations of a wide range of geometric quantities that are useful in a number of fields.\n\nSome core features of **coxeter** include:\n\n* Libraries of common shapes to support easy construction.\n* Mutable shape objects that can be rescaled in a variety of ways to suit a number of needs.\n* Immediate access to geometric properties of shapes via Python properties of shape objects.\n* Plotting functionality to make it easy to visualize shapes in both two and three dimensions.\n\nMore detailed information on **coxeter**'s features and examples of how to use them may be found in the `documentation <https://coxeter.readthedocs.io/>`__.\n\n.. _installing:\n\nSetup\n-----\n\nThe recommended methods for installing coxeter are using **pip** or **conda**.\n\nInstallation via pip\n~~~~~~~~~~~~~~~~~~~~\n\nTo install the package from PyPI, execute:\n\n.. code:: bash\n\n pip install coxeter --user\n\nInstallation via conda\n~~~~~~~~~~~~~~~~~~~~~~\n\nTo install the package from conda, first add the **conda-forge** channel:\n\n.. code:: bash\n\n conda config --add channels conda-forge\n\nAfter the **conda-forge** channel has been added, you can install coxeter by executing\n\n.. code:: bash\n\n conda install coxeter\n\nInstallation from source\n~~~~~~~~~~~~~~~~~~~~~~~~\n\nStart by executing the following:\n\n.. code:: bash\n\n git clone https://github.com/glotzerlab/coxeter.git\n cd coxeter\n\nTo install coxeter and other optional dependencies, choose one of the following:\n\n.. code:: bash\n\n pip install . # Install with no additional dependencies\n pip install .[tests] # RECOMMENDED: Install with dependencies required to run pytests\n pip install .[tests,doc] # Install all dependencies required to develop for coxeter\n\n\nRequirements\n~~~~~~~~~~~~\n\n- Python >= 3.8\n- NumPy >= 1.19.0\n- SciPy >= 1.0.0\n- rowan >= 1.2.0\n\nTesting\n-------\n\nThe package is currently tested for Python >= 3.8 on Unix-like systems.\nContinuous integrated testing is performed using Github actions on these Python versions.\n\nFirst, install the packages required to test coxeter (if not already done):\n\n.. code:: bash\n\n pip install -r tests/requirements.txt\n\nTo run the packaged unit tests, execute the following line from the root of the repository:\n\n.. code:: bash\n\n pytest\n\nTo run the packaged unit tests with the coverage module:\n\n.. code:: bash\n\n pytest --cov=coxeter\n\nBuilding Documentation\n----------------------\n\nDocumentation for coxeter is written in `reStructuredText <http://docutils.sourceforge.net/rst.html>`__ and compiled using `Sphinx <http://www.sphinx-doc.org/en/master/>`__.\nTo build the documentation, first install Sphinx and the other required packages:\n\n.. code:: bash\n\n pip install -r doc/requirements.txt\n conda install -c conda-forge fresnel\n\n.. warning::\n The `fresnel <https://fresnel.readthedocs.io/>`_ package on conda-forge must be used. The PyPI package *fresnel* is different and will not function properly.\n\nYou can then use Sphinx to create the actual documentation in either PDF or HTML form by running the following commands:\n\n.. code:: bash\n\n cd doc\n make html # For html output\n make latexpdf # For a LaTeX compiled PDF file\n open build/html/index.html\n\nSupport and Contribution\n========================\n\nThis package is hosted on `GitHub <https://github.com/glotzerlab/coxeter>`_.\nPlease report any bugs or problems that you find on the `issue tracker <https://github.com/glotzerlab/coxeter/issues>`_.\nAll contributions to coxeter are welcomed via pull requests!\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License for coxeter Copyright (c) 2015-2024 The Regents of the University of Michigan. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ",
"summary": "Tools for creating and manipulating shapes.",
"version": "0.9.0",
"project_urls": {
"Documentation": "https://coxeter.readthedocs.io",
"Download": "https://pypi.org/project/coxeter/",
"Issues": "https://github.com/glotzerlab/coxeter/issues",
"Source": "https://github.com/glotzerlab/coxeter"
},
"split_keywords": [
"geometry"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f40cbf8315c0378453ceaaf752f4e2dd42d26bca6eb4deea859cbba0b6cbdc42",
"md5": "352cc91ed7bfe330a9ab930109c2bcfe",
"sha256": "01eec6422d3b4f89493f9a056b6499897bdbd2b763a0d6f937a09b8164de2ba0"
},
"downloads": -1,
"filename": "coxeter-0.9.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "352cc91ed7bfe330a9ab930109c2bcfe",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 195615,
"upload_time": "2024-09-16T19:28:13",
"upload_time_iso_8601": "2024-09-16T19:28:13.427911Z",
"url": "https://files.pythonhosted.org/packages/f4/0c/bf8315c0378453ceaaf752f4e2dd42d26bca6eb4deea859cbba0b6cbdc42/coxeter-0.9.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c429b65f708cc5cf373d167811887d086754fd818a6cf3cc6d090733e7d88e92",
"md5": "773e88aafda06cbd59790aa5b09ac63d",
"sha256": "af38542c7280d707931cb1aad795323e465518f1c5476af5929f770eda30e816"
},
"downloads": -1,
"filename": "coxeter-0.9.0.tar.gz",
"has_sig": false,
"md5_digest": "773e88aafda06cbd59790aa5b09ac63d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 202526,
"upload_time": "2024-09-16T19:28:15",
"upload_time_iso_8601": "2024-09-16T19:28:15.760471Z",
"url": "https://files.pythonhosted.org/packages/c4/29/b65f708cc5cf373d167811887d086754fd818a6cf3cc6d090733e7d88e92/coxeter-0.9.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-16 19:28:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "glotzerlab",
"github_project": "coxeter",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "coxeter"
}
