# PanDEM
[](https://github.com/psf/black)
[Documentation here](https://scigem.github.io/pandem/), or compile it yourself following the details below.
## Installation
This package can be installed via
```
pip install pandem
```
If installing from github, try cloning and then running:
```
pip install -e .
```
## Usage
To convert a dataset from one DEM file format to antoher, at the command line type:
```
pandem <path_to_source_file> <path_to_output_file>
```
We support the following file formats:
- `.data` ([MercuryDPM](https://mercurydpm.org/))
- `.csv` or `.vtk` ([NDDEM](https://github.com/franzzzzzzzz/NDDEM/))
- `.dump` ([LIGGGHTS](https://www.cfdem.com/media/DEM/docu/liggghts.html))
<!-- - `.bz2` ([YADE](https://yade-dem.org/doc/introduction.html#saving-and-loading)) -->
<!-- - `.vtk` ([LIGGGHTS](https://www.cfdem.com/media/DEM/docu/liggghts.html)) -->
Try `pandem --help` for more options.
## Contributing
Something not working? Want to add your own file formats? Please consider making a pull request with changes. Otherwise please use the Issues tracker above.
## Documentation
We use `sphinx` to manage the docs. Update documentation with:
```
cd docs
make html
```
Once these are built, you can commit and push the changes to github to have them refreshed on github pages. You can also view them locally.
Raw data
{
"_id": null,
"home_page": null,
"name": "pandem",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "DEM, discrete element method, granular materials",
"author": null,
"author_email": "Benjy Marks <benjy.marks@sydney.edu.au>, Fran\u00e7ois Guillard <francois.guillard@sydney.edu.au>",
"download_url": "https://files.pythonhosted.org/packages/9c/41/97939002973b165252db9d765060c6f8cebb69fa70d9a1fa4a94ffa59205/pandem-0.3.1.tar.gz",
"platform": null,
"description": "# PanDEM\n[](https://github.com/psf/black)\n\n[Documentation here](https://scigem.github.io/pandem/), or compile it yourself following the details below.\n\n## Installation\nThis package can be installed via \n```\npip install pandem\n```\n\nIf installing from github, try cloning and then running:\n```\npip install -e .\n```\n\n## Usage\n\nTo convert a dataset from one DEM file format to antoher, at the command line type:\n\n```\npandem <path_to_source_file> <path_to_output_file>\n```\n\nWe support the following file formats:\n - `.data` ([MercuryDPM](https://mercurydpm.org/))\n - `.csv` or `.vtk` ([NDDEM](https://github.com/franzzzzzzzz/NDDEM/))\n - `.dump` ([LIGGGHTS](https://www.cfdem.com/media/DEM/docu/liggghts.html))\n <!-- - `.bz2` ([YADE](https://yade-dem.org/doc/introduction.html#saving-and-loading)) -->\n <!-- - `.vtk` ([LIGGGHTS](https://www.cfdem.com/media/DEM/docu/liggghts.html)) -->\n\nTry `pandem --help` for more options.\n\n## Contributing\n\nSomething not working? Want to add your own file formats? Please consider making a pull request with changes. Otherwise please use the Issues tracker above.\n\n## Documentation\n\nWe use `sphinx` to manage the docs. Update documentation with:\n```\ncd docs\nmake html\n```\nOnce these are built, you can commit and push the changes to github to have them refreshed on github pages. You can also view them locally.\n",
"bugtrack_url": null,
"license": null,
"summary": "A python package for converting between DEM code output formats",
"version": "0.3.1",
"project_urls": {
"Documentation": "https://github.com/scigem/pandem/docs/index.html",
"Repository": "https://github.com/scigem/pandem.git"
},
"split_keywords": [
"dem",
" discrete element method",
" granular materials"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a2b67e40b53985bc1a212a121bbb0ee1019866006d6653af35d808762d0bf12c",
"md5": "99771e56bc4e20d7b79ae41448424783",
"sha256": "c50f1c21e1b0bfd2811c2f6f2baa2fb1719e16b1e98c0d1a104257d0a2fc5be1"
},
"downloads": -1,
"filename": "pandem-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "99771e56bc4e20d7b79ae41448424783",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 20806,
"upload_time": "2024-12-19T02:12:23",
"upload_time_iso_8601": "2024-12-19T02:12:23.895427Z",
"url": "https://files.pythonhosted.org/packages/a2/b6/7e40b53985bc1a212a121bbb0ee1019866006d6653af35d808762d0bf12c/pandem-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9c4197939002973b165252db9d765060c6f8cebb69fa70d9a1fa4a94ffa59205",
"md5": "95cd0504ca98028e7e1a705765ce1dad",
"sha256": "ecbcfff8cfa63ca496ede93c1215ec3dcbfaa2a2c96f57b37ae304a7a87bcf09"
},
"downloads": -1,
"filename": "pandem-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "95cd0504ca98028e7e1a705765ce1dad",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 57165,
"upload_time": "2024-12-19T02:12:26",
"upload_time_iso_8601": "2024-12-19T02:12:26.176372Z",
"url": "https://files.pythonhosted.org/packages/9c/41/97939002973b165252db9d765060c6f8cebb69fa70d9a1fa4a94ffa59205/pandem-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-19 02:12:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "scigem",
"github_project": "pandem",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pandem"
}
JSON
