| Name | elematic JSON |
| Version |
1.0.4
JSON |
| download |
| home_page | None |
| Summary | Material information management via MatML for Python |
| upload_time | 2024-03-29 23:34:29 |
| maintainer | None |
| docs_url | None |
| author | Noah Gula |
| requires_python | None |
| license | MIT License Copyright (c) 2024 NOAH GULA Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
matml
information
management
materials
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<h1 align='center'> elematic </h1>
Materials information management utilities in Python using the MatML schema from NIST.
## Features
- Convert MatML XML files to Python data structures.
- Inspect and edit materials information.
- Use materials information in other Python projects.
## Documentation
[Documentation](https://github.com/nogula/elematic/wiki) is available, but still in work.
## Installation
Install elematic with pip from pypi.
```bash
pip install --upgrade elematic
```
## Usage
This package comprises four utilities:
1. `elematic.api.MatML_api`: forms the basic classes and data structure for interacting with MatML data.
1. `elematic.api.io`: provides means to import and export MatML data from XML and other files.
1. `elematic.api.utilities`: provides helper functions to streamline the interaction of materials information.
1. `elematic.gui`: (not yet implemented) provides a means of visually inspecting and editing MatML data.
See the [Wiki tutorial](https://github.com/nogula/elematic/wiki/Tutorial) for more help.
## Credits & Acknowledgements
- This project is based entirely on the MatML schema, originally developed by NIST. Thank you, NIST.
- The initial API was created by conversion of the MatML 3.1 schema to a Python data structure via [generateDS](http://www.davekuhlman.org/generateDS.htm) by Dave Kuhlman. Thank you, Dave.
## See Also
- [MatEditor](https://docs.welsim.com/mateditor/mateditor_overview/): a free material editor software program for engineers.
- [BT-MatML-Editor](https://github.com/P-McG/BT-MatML-Editor): a text editor for the MatML 3.1 XML Schema.
- [matml](https://www.mathworks.com/matlabcentral/fileexchange/19686-matml): converts between MATLAB and MatML data.
## License
Copyright is released under the [MIT](https://raw.githubusercontent.com/nogula/elematic/main/LICENSE) license.
Raw data
{
"_id": null,
"home_page": null,
"name": "elematic",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "MatML, information, management, materials",
"author": "Noah Gula",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/4e/bb/946f9a774dbc158371211d2e9276335c062683213ebbc411e11e11d348b6/elematic-1.0.4.tar.gz",
"platform": null,
"description": "<h1 align='center'> elematic </h1>\n\nMaterials information management utilities in Python using the MatML schema from NIST.\n\n## Features\n\n- Convert MatML XML files to Python data structures.\n- Inspect and edit materials information.\n- Use materials information in other Python projects.\n\n## Documentation\n\n[Documentation](https://github.com/nogula/elematic/wiki) is available, but still in work.\n## Installation\n\nInstall elematic with pip from pypi.\n\n```bash\npip install --upgrade elematic\n```\n## Usage\n\nThis package comprises four utilities:\n\n1. `elematic.api.MatML_api`: forms the basic classes and data structure for interacting with MatML data.\n1. `elematic.api.io`: provides means to import and export MatML data from XML and other files.\n1. `elematic.api.utilities`: provides helper functions to streamline the interaction of materials information.\n1. `elematic.gui`: (not yet implemented) provides a means of visually inspecting and editing MatML data.\n\nSee the [Wiki tutorial](https://github.com/nogula/elematic/wiki/Tutorial) for more help.\n\n## Credits & Acknowledgements\n- This project is based entirely on the MatML schema, originally developed by NIST. Thank you, NIST.\n- The initial API was created by conversion of the MatML 3.1 schema to a Python data structure via [generateDS](http://www.davekuhlman.org/generateDS.htm) by Dave Kuhlman. Thank you, Dave.\n\n## See Also\n- [MatEditor](https://docs.welsim.com/mateditor/mateditor_overview/): a free material editor software program for engineers.\n- [BT-MatML-Editor](https://github.com/P-McG/BT-MatML-Editor): a text editor for the MatML 3.1 XML Schema.\n- [matml](https://www.mathworks.com/matlabcentral/fileexchange/19686-matml): converts between MATLAB and MatML data.\n\n## License\nCopyright is released under the [MIT](https://raw.githubusercontent.com/nogula/elematic/main/LICENSE) license.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 NOAH GULA Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "Material information management via MatML for Python",
"version": "1.0.4",
"project_urls": {
"Documentation": "https://github.com/nogula/elematic/wiki",
"Homepage": "https://github.com/nogula/elematic",
"Issues": "https://github.com/nogula/elematic/issues",
"Repository": "https://github.com/nogula/elematic"
},
"split_keywords": [
"matml",
" information",
" management",
" materials"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "428ab27458ce87c20454d0e6dde60993fb1712a4919261829f0d02219eb19c26",
"md5": "92a2fe325525565a4b5359edf0f4ff6a",
"sha256": "fd16d887e6bc0490b40e790e69fdc7b553fb741b78cab221afd0ab78fcdf4d90"
},
"downloads": -1,
"filename": "elematic-1.0.4-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "92a2fe325525565a4b5359edf0f4ff6a",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 81697,
"upload_time": "2024-03-29T23:34:27",
"upload_time_iso_8601": "2024-03-29T23:34:27.169235Z",
"url": "https://files.pythonhosted.org/packages/42/8a/b27458ce87c20454d0e6dde60993fb1712a4919261829f0d02219eb19c26/elematic-1.0.4-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4ebb946f9a774dbc158371211d2e9276335c062683213ebbc411e11e11d348b6",
"md5": "2b881edd100185e60087d166f4680196",
"sha256": "709c6c5dfac1cccc2a2a152de56a8bb0f7c18ae8db5d56412dcb05ea7f912a11"
},
"downloads": -1,
"filename": "elematic-1.0.4.tar.gz",
"has_sig": false,
"md5_digest": "2b881edd100185e60087d166f4680196",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3512572,
"upload_time": "2024-03-29T23:34:29",
"upload_time_iso_8601": "2024-03-29T23:34:29.324638Z",
"url": "https://files.pythonhosted.org/packages/4e/bb/946f9a774dbc158371211d2e9276335c062683213ebbc411e11e11d348b6/elematic-1.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-29 23:34:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nogula",
"github_project": "elematic",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "elematic"
}
