/coredensity

Atomic electron density

Primary LanguagePython

Contributors Forks Stargazers Issues


Logo

Core Density

Providing electron density for all element


View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Roadmap
  3. Contributing
  4. License
  5. Contact
  6. Acknowledgments

About The Project

The electron density of an atom represents the probability distribution of orbital electrons as a function of distance from the nucleus. The accurate electron density is critical for scattering physics & materials characterization: the Fourier transform of the density is the X-ray scattering factor, and one can further deduce the electron scattering factor by using the Mott formula.

As the core electron of the heavy element can be very fast -- approaching the speed of light, one has to consider the relativistic effects. This project provides the electron density of each orbital for all the elements calculated by solving the Dirac equation.

The project aims to provide accurate scattering factors for electrons and X-rays, with the freedom to do any combination of orbitals.

This repo is currently under development.

(back to top)

Getting Started

To get code running locally, let's first create a conda environment.

conda create -n dense
pip install h5py numpy matplotlib

(back to top)

Roadmap

TO-DO list

  • Provide the density database solved from Dirac equation
  • Generate the X-ray scattering factor
  • Generate the electron scattering factor
  • Combine the core electrons from Dirac and the rest valence electrons from DFT to consider the effect of bonding
  • Generate the projected potential
  • Provide an interface to multislice simulation (aiming to be general for any packages)

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what makes the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the GPLv3 License. See LICENSE for more information.

(back to top)

Contact

Zezhong Zhang - zezhong.zhang@uantwerpen.be

Project Link: https://github.com/zezhong-zhang/coredensity

(back to top)

Acknowledgments

(back to top)