Exodus Helper Package
=====================
|docs| |tests| |lint|
Description/Purpose Statement
-----------------------------
This package provides native Python tools to handle ExodusII files through the NetCDF API.
Installation
------------
- Clone the |project| repo to your local disk and navigate to the created folder:
::
$ git clone git@github.com:sandialabs/exodus_helper.git
$ cd exodus_helper
- (Users): To install |project| locally
::
$ python -m pip install .
- (Developer) To install |project| so that local edits to the soure code are immediately available system-wide:
::
$ python -m pip install -e .
- To include extras, e.g. for testing (see tool.poetry.extras in pyproject.toml for available options), run:
::
$ python -m pip install ".[testing]"
Getting Started
---------------
- `Documentation <https://exodus-helper.readthedocs.io/en/latest/index.html>`_
- Release History (link pending)
- Tutorial Notebook (link pending)
- Contribution Guidelines (link pending)
.. |project| replace:: exodus_helper
.. |docs| image:: https://readthedocs.org/projects/exodus-helper/badge/?version=latest&style=flat
:target: https://exodus-helper.readthedocs.io/en/latest/index.html
:alt: docs
.. |tests| image:: https://github.com/sandialabs/exodus_helper/actions/workflows/pytest.yml/badge.svg
:target: https://github.com/sandialabs/exodus_helper/actions/workflows/pytest.yml
:alt: tests
.. |lint| image:: https://github.com/sandialabs/exodus_helper/actions/workflows/pylint.yml/badge.svg
:target: https://github.com/sandialabs/exodus_helper/actions/workflows/pylint.yml
:alt: lint
Raw data
{
"_id": null,
"home_page": "https://github.com/sandialabs/exodus_helper",
"name": "exodus-helper",
"maintainer": "Coleman Alleman",
"docs_url": null,
"requires_python": "<3.13,>=3.10",
"maintainer_email": "callema@sandia.gov",
"keywords": "finite element, ExodusII",
"author": "Coleman Alleman",
"author_email": "callema@sandia.gov",
"download_url": "https://files.pythonhosted.org/packages/04/56/f21db173e573e0a4a98d0d7f42e89d02b810be54ac39537d4946c273bd26/exodus_helper-1.2.2.tar.gz",
"platform": null,
"description": "Exodus Helper Package\n=====================\n\n|docs| |tests| |lint|\n\nDescription/Purpose Statement\n-----------------------------\nThis package provides native Python tools to handle ExodusII files through the NetCDF API.\n\nInstallation\n------------\n\n- Clone the |project| repo to your local disk and navigate to the created folder:\n\n::\n\n $ git clone git@github.com:sandialabs/exodus_helper.git\n $ cd exodus_helper\n\n- (Users): To install |project| locally\n\n::\n\n $ python -m pip install .\n\n- (Developer) To install |project| so that local edits to the soure code are immediately available system-wide:\n\n::\n\n $ python -m pip install -e .\n\n- To include extras, e.g. for testing (see tool.poetry.extras in pyproject.toml for available options), run:\n\n::\n\n $ python -m pip install \".[testing]\"\n\nGetting Started\n---------------\n\n- `Documentation <https://exodus-helper.readthedocs.io/en/latest/index.html>`_\n- Release History (link pending)\n- Tutorial Notebook (link pending)\n- Contribution Guidelines (link pending)\n\n\n.. |project| replace:: exodus_helper\n\n.. |docs| image:: https://readthedocs.org/projects/exodus-helper/badge/?version=latest&style=flat\n :target: https://exodus-helper.readthedocs.io/en/latest/index.html\n :alt: docs\n\n.. |tests| image:: https://github.com/sandialabs/exodus_helper/actions/workflows/pytest.yml/badge.svg\n :target: https://github.com/sandialabs/exodus_helper/actions/workflows/pytest.yml\n :alt: tests\n\n.. |lint| image:: https://github.com/sandialabs/exodus_helper/actions/workflows/pylint.yml/badge.svg\n :target: https://github.com/sandialabs/exodus_helper/actions/workflows/pylint.yml\n :alt: lint\n\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "A package for manipulating ExodusII databases",
"version": "1.2.2",
"project_urls": {
"Documentation": "https://github.com/sandialabs/exodus_helper",
"Homepage": "https://github.com/sandialabs/exodus_helper",
"Repository": "https://github.com/sandialabs/exodus_helper"
},
"split_keywords": [
"finite element",
" exodusii"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "651bf0257e67eaff8aed8ea86e547d13e3d607d47e8652a2b86e221f273e95c6",
"md5": "1a5bde1ac0800923740e9ce817974a5f",
"sha256": "4fe6023c25441e5e9bd5c1bba1ef912a67873c969a13988a54a3222e729b807a"
},
"downloads": -1,
"filename": "exodus_helper-1.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1a5bde1ac0800923740e9ce817974a5f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.10",
"size": 34166,
"upload_time": "2024-11-13T18:05:35",
"upload_time_iso_8601": "2024-11-13T18:05:35.230186Z",
"url": "https://files.pythonhosted.org/packages/65/1b/f0257e67eaff8aed8ea86e547d13e3d607d47e8652a2b86e221f273e95c6/exodus_helper-1.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0456f21db173e573e0a4a98d0d7f42e89d02b810be54ac39537d4946c273bd26",
"md5": "b4aa5e774886fee4bc1312aa87ed266c",
"sha256": "cfafddddc0814d7d619b080b9a125d61c32227a09962775b823a73ab8be006b6"
},
"downloads": -1,
"filename": "exodus_helper-1.2.2.tar.gz",
"has_sig": false,
"md5_digest": "b4aa5e774886fee4bc1312aa87ed266c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.10",
"size": 32458,
"upload_time": "2024-11-13T18:05:36",
"upload_time_iso_8601": "2024-11-13T18:05:36.312317Z",
"url": "https://files.pythonhosted.org/packages/04/56/f21db173e573e0a4a98d0d7f42e89d02b810be54ac39537d4946c273bd26/exodus_helper-1.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-13 18:05:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sandialabs",
"github_project": "exodus_helper",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "exodus-helper"
}