Skip to content

pyXem (Pythonic Crystallographic Electron Microscopy) is an open-source Python library for crystallographic electron microscopy. Contact us: pyxem.team@gmail.com

License

erh3cq/pyxem

 
 

Repository files navigation

image

image

Code Health

pyXem (Python Crystallographic Electron Microscopy) is an open-source Python library for crystallographic electron microscopy. It builds on the tools for multi-dimensional data analysis provided by the HyperSpy library for treatment of experimental electron diffraction data and tools for atomic structure manipulation provided by the PyMatGen library.

pyXem is released under the GPL v3 license.

HEALTH WARNING

pyXem is in the relatively early stages of development and may contain a number of bugs as a result. The code has been released at this stage in good faith and to speed up this refinement process. We hope that you will find the tools useful and if you find bugs we would appreciate knowing about them.

Install

pyXem requires python 3 and can be installed by navigating to the directory containing the package and running the following command:

$ python setup.py install

Alternativley, if you are new to python the simplest way to install everything you need is using Anaconda ( make sure to install the Python 3 version).

From a clean install the following commands to install everything you need should be entered into the terminal, or anaconda prompt terminal in Windows:

$ conda install hyperspy -c conda-forge

$ conda install --channel matsci pymatgen Cython

$ pip install transforms3d

$ python setup.py install

Citing pyXem

If pyXem has enabled significant parts of an academic publication, please acknowledge that by citing the software. Until a specific publication is written about pyXem please site the github URL: www.github.com/pyxem/pyXem

We also recommend that you cite HyperSpy and PyMatGen

About

pyXem (Pythonic Crystallographic Electron Microscopy) is an open-source Python library for crystallographic electron microscopy. Contact us: pyxem.team@gmail.com

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 100.0%