atooms-dynamics


Nameatooms-dynamics JSON
Version 1.1.2 PyPI version JSON
download
home_pagehttps://framagit.org/atooms/dynamics
SummaryNewtonian and stochastic dynamics backends for atooms
upload_time2023-07-31 12:27:11
maintainer
docs_urlNone
authorDaniele Coslovich
requires_python
licenseGPLv3
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Dynamics

[![pypi](https://img.shields.io/pypi/v/atooms-dynamics.svg)](https://pypi.python.org/pypi/atooms-dynamics/)
[![version](https://img.shields.io/pypi/pyversions/atooms-dynamics.svg)](https://pypi.python.org/pypi/atooms-dynamics/)
[![license](https://img.shields.io/pypi/l/atooms-pp.svg)](https://en.wikipedia.org/wiki/GNU_General_Public_License)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/git/https%3A%2F%2Fframagit.org%2Fatooms%2Fdynamics/HEAD?labpath=docs%2Findex.ipynb)
[![pipeline](https://framagit.org/atooms/dynamics/badges/master/pipeline.svg)](https://framagit.org/atooms/dynamics/badges/master/pipeline.svg)
[![coverage report](https://framagit.org/atooms/dynamics/badges/master/coverage.svg)](https://framagit.org/atooms/dynamics/-/commits/master)

Newtonian and stochastic dynamics backends for atooms.

## Quick start

Run a molecular dynamics simulation of a Lennard-Jones system from an existing xyz file
```python
from atooms.trajectory import Trajectory
from atooms.simulation import Simulation
from atooms.dynamics.netwonian import VelocityVerlet

# Start from the last frame of input.xyz
trajectory = Trajectory('input.xyz')
system = trajectory[-1]
system.interaction = Interaction('lennard_jones')
backend = VelocityVerlet(system, timestep=0.002)
sim = Simulation(backend, steps=200)
sim.run()
```

Do the same via the API, storing configurations in `output.xyz`,
```python
from atooms.dynamics.api import md

md('input.xyz', 'output.xyz',
   method='velocity-verlet', model='lennard_jones',
   dt=0.002, nsteps=200, config_number=20)
```

or from the command line
```sh
md.py --method velocity-verlet -n 200 --dt 0.002 --config-number 20 input.xyz output.xyz
```

## Features

Integration algorithms (work in progress)

- Netwonian dynamics
  - velocity-Verlet
  - Nose-Poincaré
  - Berendsen thermostat/barostat
  - event-driven
- Stochastic dynamics
  - overdamped Langevin dynamics

## Documentation

Check out the [tutorial](https://atooms.frama.io/dynamics/tutorial) for more examples and the [public API](https://atooms.frama.io/postprocessing/api/dynamics) for full details.

Org-mode and jupyter notebooks are available under `docs/`. You can run the tutorial interactively on [Binder]( https://mybinder.org/v2/git/https%3A%2F%2Fframagit.org%2Fatooms%2Fdynamics/HEAD?labpath=docs%2Findex.ipynb).

## Installation

From pypi
```
pip install atooms-dynamics
```

You can clone the code repository and install from source
```
git clone https://framagit.org/atooms/dynamics.git
cd dynamics
make install
```

## Contributing

Contributions to the project are welcome. If you wish to contribute, check out [these guidelines](https://framagit.org/atooms/atooms/-/blob/master/CONTRIBUTING.md).

## Authors

Daniele Coslovich: https://www.units.it/daniele.coslovich/



            

Raw data

            {
    "_id": null,
    "home_page": "https://framagit.org/atooms/dynamics",
    "name": "atooms-dynamics",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "",
    "author": "Daniele Coslovich",
    "author_email": "daniele.coslovich@umontpellier.fr",
    "download_url": "",
    "platform": null,
    "description": "# Dynamics\n\n[![pypi](https://img.shields.io/pypi/v/atooms-dynamics.svg)](https://pypi.python.org/pypi/atooms-dynamics/)\n[![version](https://img.shields.io/pypi/pyversions/atooms-dynamics.svg)](https://pypi.python.org/pypi/atooms-dynamics/)\n[![license](https://img.shields.io/pypi/l/atooms-pp.svg)](https://en.wikipedia.org/wiki/GNU_General_Public_License)\n[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/git/https%3A%2F%2Fframagit.org%2Fatooms%2Fdynamics/HEAD?labpath=docs%2Findex.ipynb)\n[![pipeline](https://framagit.org/atooms/dynamics/badges/master/pipeline.svg)](https://framagit.org/atooms/dynamics/badges/master/pipeline.svg)\n[![coverage report](https://framagit.org/atooms/dynamics/badges/master/coverage.svg)](https://framagit.org/atooms/dynamics/-/commits/master)\n\nNewtonian and stochastic dynamics backends for atooms.\n\n## Quick start\n\nRun a molecular dynamics simulation of a Lennard-Jones system from an existing xyz file\n```python\nfrom atooms.trajectory import Trajectory\nfrom atooms.simulation import Simulation\nfrom atooms.dynamics.netwonian import VelocityVerlet\n\n# Start from the last frame of input.xyz\ntrajectory = Trajectory('input.xyz')\nsystem = trajectory[-1]\nsystem.interaction = Interaction('lennard_jones')\nbackend = VelocityVerlet(system, timestep=0.002)\nsim = Simulation(backend, steps=200)\nsim.run()\n```\n\nDo the same via the API, storing configurations in `output.xyz`,\n```python\nfrom atooms.dynamics.api import md\n\nmd('input.xyz', 'output.xyz',\n   method='velocity-verlet', model='lennard_jones',\n   dt=0.002, nsteps=200, config_number=20)\n```\n\nor from the command line\n```sh\nmd.py --method velocity-verlet -n 200 --dt 0.002 --config-number 20 input.xyz output.xyz\n```\n\n## Features\n\nIntegration algorithms (work in progress)\n\n- Netwonian dynamics\n  - velocity-Verlet\n  - Nose-Poincar\u00e9\n  - Berendsen thermostat/barostat\n  - event-driven\n- Stochastic dynamics\n  - overdamped Langevin dynamics\n\n## Documentation\n\nCheck out the [tutorial](https://atooms.frama.io/dynamics/tutorial) for more examples and the [public API](https://atooms.frama.io/postprocessing/api/dynamics) for full details.\n\nOrg-mode and jupyter notebooks are available under `docs/`. You can run the tutorial interactively on [Binder]( https://mybinder.org/v2/git/https%3A%2F%2Fframagit.org%2Fatooms%2Fdynamics/HEAD?labpath=docs%2Findex.ipynb).\n\n## Installation\n\nFrom pypi\n```\npip install atooms-dynamics\n```\n\nYou can clone the code repository and install from source\n```\ngit clone https://framagit.org/atooms/dynamics.git\ncd dynamics\nmake install\n```\n\n## Contributing\n\nContributions to the project are welcome. If you wish to contribute, check out [these guidelines](https://framagit.org/atooms/atooms/-/blob/master/CONTRIBUTING.md).\n\n## Authors\n\nDaniele Coslovich: https://www.units.it/daniele.coslovich/\n\n\n",
    "bugtrack_url": null,
    "license": "GPLv3",
    "summary": "Newtonian and stochastic dynamics backends for atooms",
    "version": "1.1.2",
    "project_urls": {
        "Homepage": "https://framagit.org/atooms/dynamics"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "22d3b753708ce13eefc6f9a19e2da637d9ea84a923e2933e28b9ec27e2b3e1cb",
                "md5": "52c0100c38c623689a399698034c933a",
                "sha256": "5d809c3d8538306b8334e7307f383dfe6bb51ec42262d78ebef9860c35af2c07"
            },
            "downloads": -1,
            "filename": "atooms_dynamics-1.1.2-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "52c0100c38c623689a399698034c933a",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 14237,
            "upload_time": "2023-07-31T12:27:11",
            "upload_time_iso_8601": "2023-07-31T12:27:11.022059Z",
            "url": "https://files.pythonhosted.org/packages/22/d3/b753708ce13eefc6f9a19e2da637d9ea84a923e2933e28b9ec27e2b3e1cb/atooms_dynamics-1.1.2-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-07-31 12:27:11",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "atooms-dynamics"
}
        
Elapsed time: 0.12116s