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.1.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.1-py3-none-any.whl (14.8 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for imperial_materials_simulation-1.0.1.tar.gz
Algorithm Hash digest
SHA256 1ee08bbe1ad117c639f43b363e224c5631a618555ce91c16a952792dbe580bd4
MD5 591108adc16ce1b99c15e73e794f0003
BLAKE2b-256 231bfb6ab95477ae01b709eee0769eb0d3511f95aa56ff9eeb9a9372fc0c4adc

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for imperial_materials_simulation-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b7bcf2e0f89cc2b5a84e03f145d5119e1533b7b505a885e9cdd9375adf5d7278
MD5 de01bfa663ac93b88878808412558366
BLAKE2b-256 f13c88e5256c1ffdb5544b0ab3e134aae2133c8660f19ea4f481b26435b0480c

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

This release

1.0.1 This release

2 files

1.0.0

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