atooms-database


Nameatooms-database JSON
Version 0.3.1 PyPI version JSON
download
home_pagehttps://framagit.org/atooms/database
SummaryDatabase of interaction database for classical molecular dynamics and Monte Carlo simulations
upload_time2023-07-31 12:24:08
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.
            Atooms database
===============

[![pypi](https://img.shields.io/pypi/v/atooms-database.svg)](https://pypi.python.org/pypi/atooms-database/)
[![version](https://img.shields.io/pypi/pyversions/atooms-database.svg)](https://pypi.python.org/pypi/atooms-database/)
[![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%2Fdatabase/HEAD?labpath=docs%2Findex.ipynb)
[![pipeline](https://framagit.org/atooms/database/badges/master/pipeline.svg)](https://framagit.org/atooms/database/badges/master/pipeline.svg)
[![coverage report](https://framagit.org/atooms/database/badges/master/coverage.svg?job=test:f90)](https://framagit.org/atooms/database/-/commits/master)

A database of interaction models and trajectory samples for classical molecular dynamics and Monte Carlo simulations.

Quick start
-----------

List the available models
```python
from atooms import database
for model in database.models:
    print(model["name"])
```
```
Gaussian core
Bernu-Hiwatari-Hansen-Pastore
Kob-Andersen
Lennard-Jones
Dellavalle-Gazzillo-Frattini-Pastore
Roux-Barrat-Hansen
Coslovich-Pastore
Grigera-Cavagna-Giardina-Parisi
harmonic spheres
Wahnstrom
```

Print all the available samples
```python
for sample in database.samples:
    print(sample["path"])
```
```
coslovich_pastore/0_488db481cdac35e599922a26129c3e35.xyz
kob_andersen/0_8f4a9fe755e5c1966c10b50c9a53e6bf.xyz
grigera_cavagna_giardina_parisi/0_0ac97fa8c69c320e48bd1fca80855e8a.xyz
lennard_jones/0_5cc3b80bc415fa5c262e83410ca65779.xyz
lennard_jones/0_13ce47602b259f7802e89e23ffd57f19.xyz
bernu_hiwatari_hansen_pastore/0_f61d7e58b9656cf9640f6e5754441930.xyz
```

Get a local copy of a Lennard-Jones fluid sample
```python
local_file = database.samples.copy("lennard_jones/0_5cc3b80bc415fa5c262e83410ca65779.xyz")
```

The `local_file` can then be used to start a simulation or further analysis using `atooms` packages.

Documentation
-------------
Check out the [documentation](https://atooms.frama.io/docs/database.html) for full details.

Installation
------------
Clone the code repository and install from source
```
git clone https://framagit.org/atooms/database.git
cd database
pip install .
```

Install `atooms-database` with pip
```
pip install atooms-database
```

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/database",
    "name": "atooms-database",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "",
    "author": "Daniele Coslovich",
    "author_email": "dcoslovich@units.it",
    "download_url": "",
    "platform": null,
    "description": "Atooms database\n===============\n\n[![pypi](https://img.shields.io/pypi/v/atooms-database.svg)](https://pypi.python.org/pypi/atooms-database/)\n[![version](https://img.shields.io/pypi/pyversions/atooms-database.svg)](https://pypi.python.org/pypi/atooms-database/)\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%2Fdatabase/HEAD?labpath=docs%2Findex.ipynb)\n[![pipeline](https://framagit.org/atooms/database/badges/master/pipeline.svg)](https://framagit.org/atooms/database/badges/master/pipeline.svg)\n[![coverage report](https://framagit.org/atooms/database/badges/master/coverage.svg?job=test:f90)](https://framagit.org/atooms/database/-/commits/master)\n\nA database of interaction models and trajectory samples for classical molecular dynamics and Monte Carlo simulations.\n\nQuick start\n-----------\n\nList the available models\n```python\nfrom atooms import database\nfor model in database.models:\n    print(model[\"name\"])\n```\n```\nGaussian core\nBernu-Hiwatari-Hansen-Pastore\nKob-Andersen\nLennard-Jones\nDellavalle-Gazzillo-Frattini-Pastore\nRoux-Barrat-Hansen\nCoslovich-Pastore\nGrigera-Cavagna-Giardina-Parisi\nharmonic spheres\nWahnstrom\n```\n\nPrint all the available samples\n```python\nfor sample in database.samples:\n    print(sample[\"path\"])\n```\n```\ncoslovich_pastore/0_488db481cdac35e599922a26129c3e35.xyz\nkob_andersen/0_8f4a9fe755e5c1966c10b50c9a53e6bf.xyz\ngrigera_cavagna_giardina_parisi/0_0ac97fa8c69c320e48bd1fca80855e8a.xyz\nlennard_jones/0_5cc3b80bc415fa5c262e83410ca65779.xyz\nlennard_jones/0_13ce47602b259f7802e89e23ffd57f19.xyz\nbernu_hiwatari_hansen_pastore/0_f61d7e58b9656cf9640f6e5754441930.xyz\n```\n\nGet a local copy of a Lennard-Jones fluid sample\n```python\nlocal_file = database.samples.copy(\"lennard_jones/0_5cc3b80bc415fa5c262e83410ca65779.xyz\")\n```\n\nThe `local_file` can then be used to start a simulation or further analysis using `atooms` packages.\n\nDocumentation\n-------------\nCheck out the [documentation](https://atooms.frama.io/docs/database.html) for full details.\n\nInstallation\n------------\nClone the code repository and install from source\n```\ngit clone https://framagit.org/atooms/database.git\ncd database\npip install .\n```\n\nInstall `atooms-database` with pip\n```\npip install atooms-database\n```\n\nContributing\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\nAuthors\n-------\nDaniele Coslovich: https://www.units.it/daniele.coslovich/\n\n\n",
    "bugtrack_url": null,
    "license": "GPLv3",
    "summary": "Database of interaction database for classical molecular dynamics and Monte Carlo simulations",
    "version": "0.3.1",
    "project_urls": {
        "Homepage": "https://framagit.org/atooms/database"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ba9c0f6134d65244de275a1b69d0afbb406cda43fcfbd0c21968524492b71782",
                "md5": "e66d5dc7823fab5851d9d6d25ca540da",
                "sha256": "576f7c09fc730af0b33cdb06b10db3ff3df80a1e6f442813452c74528c8de160"
            },
            "downloads": -1,
            "filename": "atooms_database-0.3.1-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e66d5dc7823fab5851d9d6d25ca540da",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 61519,
            "upload_time": "2023-07-31T12:24:08",
            "upload_time_iso_8601": "2023-07-31T12:24:08.892230Z",
            "url": "https://files.pythonhosted.org/packages/ba/9c/0f6134d65244de275a1b69d0afbb406cda43fcfbd0c21968524492b71782/atooms_database-0.3.1-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-07-31 12:24:08",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "atooms-database"
}
        
Elapsed time: 0.10228s