Skip to main content

Imperial Materials Simulation

Molecular simulation tool made for the theory and simulation module taken by materials science and engineering undergraduates at Imperial College London.

minimal use example

It models the forces acting on a molecule in different situations and displays the results live using an interactive Jupyter notebook dashboard.

Method

Each polymer is a linear string of beads (CH2 units) with no side chains. Bonds are modelled as springs and long range interactions are modelled using a 12-6 Lennard-Jones potential.

Four methods of atomistic simulation are implemented:

  1. Steepest descent structural relaxation / energy minimization.

  2. Constant temperature ('NVT') dynamics with a Langevin thermostat.

  3. Constant energy Hamiltonian ('NVE') molecular dynamics.

  4. Metropolis Monte Carlo ('MMC') stochastic model.

For each time step, the forces and potentials of each atom are calculated. This allows for their positions and velocities to be updated following the given atomistic simluation method.

Installation

This library can be installed from pypi:

pip install imperial-materials-simulation

For developement use, the codebase can be cloned from GitHub:

git clone https://github.com/AyhamSaffar/imperial-materials-simulation.git

Dependancies for developement use can optionally be installed using the dedicated conda enviroment:

conda config --add channels conda-forge

conda create --name sim_env --file conda_env.txt

Usage

All examples shown can be found in the examples notebook.

All functionality and details are well documented in the doc-strings of the main Simulation class and its methods.

Minimal use

minimal use example

Data collection

data collection example

Detailed Analysis

detailed analysis example

Support

Any issues with the library should be raised directly with Paul Tangney.

There is a known bug that sometimes makes the .display() method show a column of plots at once. This is being worked on, but for the moment can be fixed with a quick computer restart.

Roadmap

The following features could be implemented down the road following popular demand:

  • Replace MatPlotLib graphs in display with Plotly for a faster & more responsive dashboard (especially when its live updating during longer runs).

  • Add run .xyz trajectory exporter for better integration with external software.

  • Added support for charged functional groups on the simulated molecule and a VRORV integrator to better account for the added electrostatic forces.

  • Add artist to run dataframe on dashboard so numbers are displayed in scientific format and the row for the current run gets highlighted.

Authors and Acknowledgment

This program was written by me, Ayham Al-Saffar, based on Paul Tangney's initial codebase and was funded by an Imperial College London Student Shapers grant.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

imperial_materials_simulation-1.0.0.tar.gz (14.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

imperial_materials_simulation-1.0.0-py3-none-any.whl (14.7 kB view details)

Uploaded Python 3

File details

Details for the file imperial_materials_simulation-1.0.0.tar.gz.

File metadata

File hashes

Hashes for imperial_materials_simulation-1.0.0.tar.gz
Algorithm Hash digest
SHA256 50e219078faca509aca83780cc8ee8a3fa68bf49432a20c6ca4908f6009724a3
MD5 d9c9fe0a144954c40c91a20e55059da9
BLAKE2b-256 b7a8ef922ff0c0eedef317b65b35163c73890e179eb98829709d48227689e227

See more details on using hashes here.

File details

Details for the file imperial_materials_simulation-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for imperial_materials_simulation-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bf7e77074576d19be1735df00eef01852d7ad918baa03b2142bd2efc07c3d34b
MD5 d307f594981333e8dc5575a9fe9039fd
BLAKE2b-256 2eb1023253e90003e2de65f3a5e6a9d8cc4796afd50ae46d1cedfb08111f8195

See more details on using hashes here.

Release history Release notifications | RSS feed

1.3.5

2 files

1.3.3

2 files

1.3.2

2 files

1.3.1

2 files

1.3.0

2 files

1.2.1

2 files

1.2.0

2 files

1.1.3

2 files

1.1.2

2 files

1.1.1

2 files

1.1.0

2 files

1.0.2

2 files

1.0.1

2 files

This release

1.0.0 This release

2 files

0.0.1

2 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