Skip to main content

ANIAnimator

PyPI version PyPI pyversions Python package codecov Codacy Badge PyPI download month PyPI download week PyPI download day GitHub all releases GitHub contributors CodeFactor Codacy Badge PyPI license DOI

ANIAnimator makes the GIF file from a given chemical ANI file.

Installation

Use the package manager pip to install ANIAnimator.

$ 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

Usage

In code

Simple usage

ANIAnimator.animate(anifile="graphene.ANI")

Advance usage

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

$ python -m ANIAnimator graphene.ANI

Advance usage

$ 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 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.

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.

@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

Release files for ANIAnimator 0.2.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ANIAnimator 0.2.2
File Size Uploaded
ANIAnimator-0.2.2.tar.gz 19.4 kB Details

Built distributions (wheels)

Table of built distributions (wheels) for ANIAnimator 0.2.2
File Interpreter ABI Platform
ANIAnimator-0.2.2-py3.10.egg Legacy Egg format - - Details
ANIAnimator-0.2.2-py3-none-any.whl Python 3 none any Details

Total release size: 47.8 kB

Release files / ANIAnimator-0.2.2.tar.gz

Download URL ANIAnimator-0.2.2.tar.gz
Size 19.4 kB
Tags Source
SHA-256 checksum
How to use checksums
05436996dbbff4f580bc9409da73dff45394d68fd26b85c2c1a7c397a3a99171
BLAKE2b-256 checksum
How to use checksums
bd6665eaea91a095e58967eb560be2748b11b21c809b4579e9fa7514998b790b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.8

Release files / ANIAnimator-0.2.2-py3.10.egg

Download URL ANIAnimator-0.2.2-py3.10.egg
Size 10.4 kB
Tags Egg
SHA-256 checksum
How to use checksums
f95581ea7bb49020827d3e5f6678eb31cb9a46aca1b75a3096fcc48e3753c5ad
BLAKE2b-256 checksum
How to use checksums
9ffbc4d7bf03a31ec9123f6345564574d7e756b968e98624212b2cd8b23091ed
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.8

Release files / ANIAnimator-0.2.2-py3-none-any.whl

Download URL ANIAnimator-0.2.2-py3-none-any.whl
Size 18.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
578a0e3487a51218a7efc4b10157cd8425806b22c0c89952cfb06aa1a217ba7e
BLAKE2b-256 checksum
How to use checksums
8f826ccfad9142fbdd87cf320db119746e96e0b33bffab7b96206b0723554421
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.8

Release history Release notifications | RSS feed

This release

0.2.2 This release

3 release files

0.2.1

3 release files

0.2.0

2 release files

0.1.0

2 release files

0.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page