{ "info": { "author": "Kenneth (Kip) Hart", "author_email": "kiphart91@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Intended Audience :: Science/Research", "License :: OSI Approved :: MIT License", "Operating System :: MacOS :: MacOS X", "Operating System :: Microsoft :: Windows", "Operating System :: POSIX :: Linux", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Topic :: Scientific/Engineering", "Topic :: Scientific/Engineering :: Mathematics", "Topic :: Scientific/Engineering :: Physics" ], "description": "MicroStructPy - Microstructure Mesh Generation in Python\n========================================================\n\n|s-travis|\n|s-license|\n\n|l-github| `Repository`_\n|l-rtd| `Documentation`_\n|l-pypi| `PyPI`_\n\nMicroStructPy is a microstructure mesh generator written in Python.\nFeatures of MicroStructPy include:\n\n* 2D and 3D microstructures\n* Grain size, shape, orientation, and position control\n* Polycrystals, amorphous phases, and voids\n* Mesh verification\n* Visualizations\n* Output to common file formats\n* Customizable workflow\n\n\n.. image:: https://docs.microstructpy.org/en/latest/_images/banner.png\n :alt: Banner image showing the three steps for creating microstructure.\n\n*The three steps to creating a microstructure are:\n1) seed the domain with particles,\n2) create a Voronoi power diagram, and\n3) convert the diagram into an unstructured mesh.*\n\nDownload & Installation\n-----------------------\n\nTo install MicroStructPy, download it from PyPI using::\n\n pip install microstructpy\n\nIf there is an error with the install, try ``pip install pybind11`` first,\nthen install MicroStructPy.\n\n\nMicroStructPy can also be installed from source::\n\n git clone https://github.com/kip-hart/MicroStructPy.git\n pip install -e MicroStructPy/\n\nInstalling MicroStructPy creates the command line program ``microstructpy`` and\nthe Python package ``microstructpy``.\nThe command line program executes a standard workflow on XML input files,\nwhile the package exposes classes and functions for a customized workflow.\n\n\nRun a Demo\n----------\n\nMicroStructPy includes several demo and example files to help new users get\nstarted with the program.\nA full list of examples is available online at\nhttps://docs.microstructpy.org/examples.html.\n\nHere is minimal example input file:\n\n.. code-block:: XML\n\n \n \n \n circle \n 0.15 \n \n\n \n square \n \n \n\nThis example can be run from the command line by excuting::\n\n microstructpy --demo=minimal.xml\n\nAlternatively, you can copy the text to a file such as\n``my_input.xml`` and run ``microstructpy my_input.xml``.\n\nThe same output can be obtained from using the package in a script:\n\n.. code-block:: python\n\n import matplotlib.pyplot as plt\n import microstructpy as msp\n\n\n phase = {'shape': 'circle', 'size': 0.15}\n domain = msp.geometry.Square()\n\n # Unpositioned list of seeds\n seeds = msp.seeding.SeedList.from_info(phase, domain.area)\n\n # Position seeds in domain\n seeds.position(domain)\n\n # Create polygonal mesh\n polygon_mesh = msp.meshing.PolyMesh.from_seeds(seeds, domain)\n\n # Create triangular mesh\n triangle_mesh = msp.meshing.TriMesh.from_polymesh(polygon_mesh)\n\n # Plot outputs\n for output in [seeds, polygon_mesh, triangle_mesh]:\n plt.figure()\n output.plot(edgecolor='k')\n plt.axis('image')\n plt.axis([-0.5, 0.5, -0.5, 0.5])\n plt.show()\n\nDocumentation\n-------------\n\nMicroStructPy documentation is available online at\nhttps://docs.microstructpy.org.\n\nTo build a local copy of the documentation, execute the following from the\ntop-level directory of the MicroStructPy repository::\n\n pip install tox\n tox -e docs\n\nOnce built, the documentation will be in ``docs/build/``.\n\nContributing\n------------\n\nContributions to the project are welcome.\nPlease use the GitHub pull request and issue submission features.\n\n\nLicense and Attributions\n------------------------\n\nMicroStructPy is open source and freely availabe under the terms of the the\nMIT license.\nCopyright for MicroStructPy is held by Georgia Tech Research Corporation.\nMicroStructPy is a major part of Kenneth (Kip) Hart's doctoral thesis,\nadvised by Prof. Julian Rimoli.\n\n\n.. LINKS\n\n.. _Documentation : https://microstructpy.readthedocs.io\n.. _GitHub: https://github.com/kip-hart/MicroStructPy\n.. _PyPI : https://pypi.org/project/microstructpy/\n.. _Repository: https://github.com/kip-hart/MicroStructPy\n\n.. EXTERNAL IMAGES\n\n.. |l-github| image:: https://api.iconify.design/octicon:mark-github.svg?color=black0&inline=true&height=16\n :alt: GitHub\n\n.. |l-rtd| image:: https://api.iconify.design/simple-icons:readthedocs.svg?color=black&inline=true&height=16\n :alt: ReadTheDocs\n\n.. |l-pypi| image:: https://api.iconify.design/mdi:cube-outline.svg?color=black&inline=true&height=16\n :alt: PyPI\n\n\n.. SHIELDS\n\n.. |s-travis| image:: https://img.shields.io/travis/kip-hart/MicroStructPy\n :target: https://travis-ci.org/kip-hart/MicroStructPy\n :alt: Travis CI\n\n.. |s-license| image:: https://img.shields.io/github/license/kip-hart/MicroStructPy\n :target: https://github.com/kip-hart/MicroStructPy/blob/master/LICENSE.rst\n :alt: License\n\n\n", "description_content_type": "text/x-rst", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/kip-hart/MicroStructPy", "keywords": "microstructure,micromechanics,finite element,FEM,FEA,mesh,polycrystal,tessellation,Laguerre tessellation,multi-sphere", "license": "MIT License", "maintainer": "", "maintainer_email": "", "name": "microstructpy", "package_url": "https://pypi.org/project/microstructpy/", "platform": "", "project_url": "https://pypi.org/project/microstructpy/", "project_urls": { "Documentation": "https://docs.microstructpy.org", "Homepage": "https://github.com/kip-hart/MicroStructPy" }, "release_url": "https://pypi.org/project/microstructpy/1.1.0/", "requires_dist": [ "aabbtree", "matplotlib (<3.1.0,>=2.2.0)", "pybind11", "meshpy", "numpy (>=1.13.0)", "pyquaternion", "pyvoro-mmalahe", "scipy", "xmltodict" ], "requires_python": "", "summary": "Microstructure modeling, mesh generation, analysis, and visualization.", "version": "1.1.0" }, "last_serial": 5986499, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "23f8b8880b8f325d1df5f30a14d14d16", "sha256": "9d7cb300d81cbdf805a637e8f56e2ed36eb83309a64f17a2de3378c5adcf2888" }, "downloads": -1, "filename": "microstructpy-1.0.0.tar.gz", "has_sig": false, "md5_digest": "23f8b8880b8f325d1df5f30a14d14d16", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 118574, "upload_time": "2019-10-16T21:16:35", "url": "https://files.pythonhosted.org/packages/8b/7a/81fd46730df66a7bede21c584a5ed57ff15a5756edf69f0ac75821cfea2f/microstructpy-1.0.0.tar.gz" } ], "1.0.1": [ { "comment_text": "", "digests": { "md5": "3bda1b8bf6f0aed7c3eae831439a6665", "sha256": "a8a3f50588ed7d66ad15127b4501140a67945e299b649f10dd5592fc85a1f2de" }, "downloads": -1, "filename": "microstructpy-1.0.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "3bda1b8bf6f0aed7c3eae831439a6665", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 80217, "upload_time": "2019-09-07T03:43:44", "url": "https://files.pythonhosted.org/packages/3c/22/247f01d4c99fbbf4e27e167b23b6d9ff72d3eb483c95048ef59c76ac8643/microstructpy-1.0.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "a5fd31efc4848b04c26fdc5a548a382c", "sha256": "0bcfceacd5a5467d5ed0a4d32803f37e623f67c98d43990c78902611bec99780" }, "downloads": -1, "filename": "microstructpy-1.0.1.tar.gz", "has_sig": false, "md5_digest": "a5fd31efc4848b04c26fdc5a548a382c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 20226428, "upload_time": "2019-09-07T03:43:48", "url": "https://files.pythonhosted.org/packages/80/b2/75e85d1bb4b65ea1e99bf51c013c630931e9d101d26c6e247d9182363f86/microstructpy-1.0.1.tar.gz" } ], "1.1.0": [ { "comment_text": "", "digests": { "md5": "168f4ce612a7cb7984c3edd51f846430", "sha256": "6cced0f95103bf995e41fd2545cf84040db844cbcba6bca9606f5187e65d3f73" }, "downloads": -1, "filename": "microstructpy-1.1.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "168f4ce612a7cb7984c3edd51f846430", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 81165, "upload_time": "2019-10-16T21:36:08", "url": "https://files.pythonhosted.org/packages/ff/f1/c2c6de957bc94edae0f1871a252373efd503f2b4cd5b0f82fb2213cdee6f/microstructpy-1.1.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "66f0c29b069a51f44f6dbaa2c31bb131", "sha256": "a88bac49f47f7e26847c7f80aec6364f0a57e56df4daccef4a2ba349467c22a5" }, "downloads": -1, "filename": "microstructpy-1.1.0.tar.gz", "has_sig": false, "md5_digest": "66f0c29b069a51f44f6dbaa2c31bb131", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7350392, "upload_time": "2019-10-16T21:36:11", "url": "https://files.pythonhosted.org/packages/25/9c/f5e61d1634ff4d7ab4065596f5e1cd08d3d8d6f200d136817d407e16a7e6/microstructpy-1.1.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "168f4ce612a7cb7984c3edd51f846430", "sha256": "6cced0f95103bf995e41fd2545cf84040db844cbcba6bca9606f5187e65d3f73" }, "downloads": -1, "filename": "microstructpy-1.1.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "168f4ce612a7cb7984c3edd51f846430", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 81165, "upload_time": "2019-10-16T21:36:08", "url": "https://files.pythonhosted.org/packages/ff/f1/c2c6de957bc94edae0f1871a252373efd503f2b4cd5b0f82fb2213cdee6f/microstructpy-1.1.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "66f0c29b069a51f44f6dbaa2c31bb131", "sha256": "a88bac49f47f7e26847c7f80aec6364f0a57e56df4daccef4a2ba349467c22a5" }, "downloads": -1, "filename": "microstructpy-1.1.0.tar.gz", "has_sig": false, "md5_digest": "66f0c29b069a51f44f6dbaa2c31bb131", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7350392, "upload_time": "2019-10-16T21:36:11", "url": "https://files.pythonhosted.org/packages/25/9c/f5e61d1634ff4d7ab4065596f5e1cd08d3d8d6f200d136817d407e16a7e6/microstructpy-1.1.0.tar.gz" } ] }