Installation

ndispers works on Python 3.7 or higher.

You can install it using pip:

$ pip install ndispers

Check the version installed is the latest. If not, specify the latest version by:

$ pip install ndispers==x.y.z

To uninstall:

$ pip uninstall ndispers

To update version:

$ pip install -U ndispers

Testing your installation

You can check that ndispers is working correctly by starting up a python shell.

In [1]: import ndispers as nd

In [2]: nd.media.crystals.BetaBBO_Eimerl1987()
Out[2]: <ndispers.media.crystals._betaBBO_Eimerl1987.BetaBBO at 0x105368d50>

Here you can see that beta-BBO object is created (Please do not forget that in In[2] () is needed to get a mediaum object). If it fails, feel free to open an issue in issue tracker.

Note

It is strongly reccomended using IPython shell or JupyterLab because they have Tab completion function, which is very useful to search for available crystals and glasses.