# ANIAnimator
[](https://badge.fury.io/py/ANIAnimator)
[](https://pypi.python.org/pypi/ANIAnimator/)
[](https://github.com/eftalgezer/ANIAnimator/actions/workflows/python-package.yml)
[](https://codecov.io/gh/eftalgezer/ANIAnimator)
[](https://www.codacy.com/gh/eftalgezer/ANIAnimator/dashboard?utm_source=github.com&utm_medium=referral&utm_content=eftalgezer/ANIAnimator&utm_campaign=Badge_Coverage)
[](https://pypi.python.org/pypi/ANIAnimator/)
[](https://pypi.python.org/pypi/ANIAnimator/)
[](https://pypi.python.org/pypi/ANIAnimator/)
[](https://github.com/eftalgezer/ANIAnimator/graphs/contributors/)
[](https://www.codefactor.io/repository/github/eftalgezer/ANIAnimator)
[](https://www.codacy.com/gh/eftalgezer/ANIAnimator/dashboard?utm_source=github.com&utm_medium=referral&utm_content=eftalgezer/ANIAnimator&utm_campaign=Badge_Grade)
[](https://pypi.python.org/pypi/ANIAnimator/)
[](https://zenodo.org/badge/latestdoi/541231117)
ANIAnimator makes the GIF file from a given chemical ANI file.
## Installation
Use the package manager [pip](https://pip.pypa.io/en/stable/) to install ANIAnimator.
```bash
$ pip install ANIAnimator
# to make sure you have the latest version
$ pip install -U ANIAnimator
# latest available code base
$ pip install -U git+https://github.com/eftalgezer/ANIAnimator.git
```
## Tutorial
- [ANIAnimator v0.0.1 tutorial](https://beyondthearistotelian.blogspot.com/2022/09/anianimator-v001-tutorial.html)
- [What is new in ANIAnimator v0.1.0?](https://beyondthearistotelian.blogspot.com/2022/10/what-is-new-in-anianimator-v010.html)
## Usage
### In code
#### Simple usage
```python
ANIAnimator.animate(anifile="graphene.ANI")
```
#### Advance usage
```python
ANIAnimator.animate(anifile="graphene.ANI", width=1920, height=1080) # defaults are 1920 × 1080, respectively
ANIAnimator.animate(anifile="graphene.ANI", loop=1) # default is 0; 0 means loop, 1 means no loop
ANIAnimator.animate(anifile="graphene.ANI", bonds_param=1.3) # default is 1.3, sets the bonds between atoms
ANIAnimator.animate(anifile="graphene.ANI", camera=((40, 0, 0),
(0, 0, 0),
(0, 1, 0))) # if you need to set the camera
```
### In terminal
#### Simple usage
```sh
$ python -m ANIAnimator graphene.ANI
```
#### Advance usage
```sh
$ python -m ANIAnimator <ANI file> <width> <height> <loop> <bonds_param> camera=<param>
$ python -m ANIAnimator graphene.ANI 1920 1080 1 1.3
$ python -m ANIAnimator graphene.ANI 1920 1080 1 1.3 camera=40,0,0,0,0,0,0,1,0 # if you need to set the camera
```
### About `bonds_param` parameter
ANIAnimator uses [mogli](https://github.com/sciapp/mogli) to create PNG images of the steps in ANI files. The default of mogli package is `1.0`. ANIAnimator default is `1.3` since the experience shows that `1.3` is better. For details, see the [README.md of mogli package](https://github.com/sciapp/mogli/blob/master/README.md).
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
## Citation
If you are using ANIAnimator, please citate relevant version. You can find the relevant citation [here](https://doi.org/10.5281/zenodo.7112024).
```bibtex
@software{eftal_gezer_2023_7182193,
author = {Eftal Gezer},
title = {eftalgezer/ANIAnimator: v0.2.2},
month = jan,
year = 2023,
publisher = {Zenodo},
version = {v0.2.2},
doi = {10.5281/zenodo.7577421},
url = {https://doi.org/10.5281/zenodo.7577421}
}
```
## License
[GNU General Public License v3.0](https://github.com/eftalgezer/ANIAnimator/blob/master/LICENSE)
Raw data
{
"_id": null,
"home_page": "https://github.com/eftalgezer/ANIAnimator",
"name": "ANIAnimator",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "ANI,GIF,animation,molecular calculations,chemistry,physics,ANI to GIF converter",
"author": "Eftal Gezer",
"author_email": "eftal.gezer@astrobiyoloji.org",
"download_url": "https://files.pythonhosted.org/packages/bd/66/65eaea91a095e58967eb560be2748b11b21c809b4579e9fa7514998b790b/ANIAnimator-0.2.2.tar.gz",
"platform": null,
"description": "# ANIAnimator\n[](https://badge.fury.io/py/ANIAnimator)\n[](https://pypi.python.org/pypi/ANIAnimator/)\n[](https://github.com/eftalgezer/ANIAnimator/actions/workflows/python-package.yml)\n[](https://codecov.io/gh/eftalgezer/ANIAnimator)\n[](https://www.codacy.com/gh/eftalgezer/ANIAnimator/dashboard?utm_source=github.com&utm_medium=referral&utm_content=eftalgezer/ANIAnimator&utm_campaign=Badge_Coverage)\n[](https://pypi.python.org/pypi/ANIAnimator/)\n[](https://pypi.python.org/pypi/ANIAnimator/)\n[](https://pypi.python.org/pypi/ANIAnimator/)\n\n[](https://github.com/eftalgezer/ANIAnimator/graphs/contributors/)\n[](https://www.codefactor.io/repository/github/eftalgezer/ANIAnimator)\n[](https://www.codacy.com/gh/eftalgezer/ANIAnimator/dashboard?utm_source=github.com&utm_medium=referral&utm_content=eftalgezer/ANIAnimator&utm_campaign=Badge_Grade)\n[](https://pypi.python.org/pypi/ANIAnimator/)\n[](https://zenodo.org/badge/latestdoi/541231117)\n\nANIAnimator makes the GIF file from a given chemical ANI file.\n\n## Installation\n\nUse the package manager [pip](https://pip.pypa.io/en/stable/) to install ANIAnimator.\n\n```bash\n$ pip install ANIAnimator\n\n# to make sure you have the latest version\n$ pip install -U ANIAnimator\n\n# latest available code base\n$ pip install -U git+https://github.com/eftalgezer/ANIAnimator.git\n```\n\n## Tutorial\n\n- [ANIAnimator v0.0.1 tutorial](https://beyondthearistotelian.blogspot.com/2022/09/anianimator-v001-tutorial.html)\n- [What is new in ANIAnimator v0.1.0?](https://beyondthearistotelian.blogspot.com/2022/10/what-is-new-in-anianimator-v010.html)\n\n## Usage\n\n### In code\n\n#### Simple usage\n\n```python\nANIAnimator.animate(anifile=\"graphene.ANI\")\n\n```\n\n#### Advance usage\n\n```python\nANIAnimator.animate(anifile=\"graphene.ANI\", width=1920, height=1080) # defaults are 1920 \u00d7 1080, respectively\n\nANIAnimator.animate(anifile=\"graphene.ANI\", loop=1) # default is 0; 0 means loop, 1 means no loop\n\nANIAnimator.animate(anifile=\"graphene.ANI\", bonds_param=1.3) # default is 1.3, sets the bonds between atoms\n\nANIAnimator.animate(anifile=\"graphene.ANI\", camera=((40, 0, 0),\n (0, 0, 0),\n (0, 1, 0))) # if you need to set the camera\n```\n### In terminal\n\n#### Simple usage\n\n```sh\n$ python -m ANIAnimator graphene.ANI\n```\n\n#### Advance usage\n\n```sh\n$ python -m ANIAnimator <ANI file> <width> <height> <loop> <bonds_param> camera=<param>\n\n$ python -m ANIAnimator graphene.ANI 1920 1080 1 1.3\n\n$ python -m ANIAnimator graphene.ANI 1920 1080 1 1.3 camera=40,0,0,0,0,0,0,1,0 # if you need to set the camera\n\n```\n\n### About `bonds_param` parameter\nANIAnimator uses [mogli](https://github.com/sciapp/mogli) to create PNG images of the steps in ANI files. The default of mogli package is `1.0`. ANIAnimator default is `1.3` since the experience shows that `1.3` is better. For details, see the [README.md of mogli package](https://github.com/sciapp/mogli/blob/master/README.md).\n\n## Contributing\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.\n\nPlease make sure to update tests as appropriate.\n\n## Citation\nIf you are using ANIAnimator, please citate relevant version. You can find the relevant citation [here](https://doi.org/10.5281/zenodo.7112024).\n\n```bibtex\n@software{eftal_gezer_2023_7182193,\n author = {Eftal Gezer},\n title = {eftalgezer/ANIAnimator: v0.2.2},\n month = jan,\n year = 2023,\n publisher = {Zenodo},\n version = {v0.2.2},\n doi = {10.5281/zenodo.7577421},\n url = {https://doi.org/10.5281/zenodo.7577421}\n}\n```\n\n## License\n[GNU General Public License v3.0](https://github.com/eftalgezer/ANIAnimator/blob/master/LICENSE) \n \n",
"bugtrack_url": null,
"license": "",
"summary": "ANIAnimator makes the GIF file from a given chemical ANI file",
"version": "0.2.2",
"split_keywords": [
"ani",
"gif",
"animation",
"molecular calculations",
"chemistry",
"physics",
"ani to gif converter"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9ffbc4d7bf03a31ec9123f6345564574d7e756b968e98624212b2cd8b23091ed",
"md5": "37c3a86a24e6a292d1154f0c241bc36b",
"sha256": "f95581ea7bb49020827d3e5f6678eb31cb9a46aca1b75a3096fcc48e3753c5ad"
},
"downloads": -1,
"filename": "ANIAnimator-0.2.2-py3.10.egg",
"has_sig": false,
"md5_digest": "37c3a86a24e6a292d1154f0c241bc36b",
"packagetype": "bdist_egg",
"python_version": "0.2.2",
"requires_python": null,
"size": 10383,
"upload_time": "2023-01-27T21:55:02",
"upload_time_iso_8601": "2023-01-27T21:55:02.222000Z",
"url": "https://files.pythonhosted.org/packages/9f/fb/c4d7bf03a31ec9123f6345564574d7e756b968e98624212b2cd8b23091ed/ANIAnimator-0.2.2-py3.10.egg",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8f826ccfad9142fbdd87cf320db119746e96e0b33bffab7b96206b0723554421",
"md5": "ec2be69650ac590ed4c775e64f2a319d",
"sha256": "578a0e3487a51218a7efc4b10157cd8425806b22c0c89952cfb06aa1a217ba7e"
},
"downloads": -1,
"filename": "ANIAnimator-0.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ec2be69650ac590ed4c775e64f2a319d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 17990,
"upload_time": "2023-01-27T21:55:00",
"upload_time_iso_8601": "2023-01-27T21:55:00.427886Z",
"url": "https://files.pythonhosted.org/packages/8f/82/6ccfad9142fbdd87cf320db119746e96e0b33bffab7b96206b0723554421/ANIAnimator-0.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bd6665eaea91a095e58967eb560be2748b11b21c809b4579e9fa7514998b790b",
"md5": "245a3febefd45e292dd236e47d30f42e",
"sha256": "05436996dbbff4f580bc9409da73dff45394d68fd26b85c2c1a7c397a3a99171"
},
"downloads": -1,
"filename": "ANIAnimator-0.2.2.tar.gz",
"has_sig": false,
"md5_digest": "245a3febefd45e292dd236e47d30f42e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 19433,
"upload_time": "2023-01-27T21:55:04",
"upload_time_iso_8601": "2023-01-27T21:55:04.075766Z",
"url": "https://files.pythonhosted.org/packages/bd/66/65eaea91a095e58967eb560be2748b11b21c809b4579e9fa7514998b790b/ANIAnimator-0.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-27 21:55:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "eftalgezer",
"github_project": "ANIAnimator",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "anianimator"
}
JSON
