Coder Social home page Coder Social logo

wmd-group / macrodensity Goto Github PK

View Code? Open in Web Editor NEW
82.0 10.0 44.0 288.67 MB

Python package to analyse electron density & electrostatic potential grids

Home Page: https://macrodensity.readthedocs.io

License: MIT License

Python 95.24% Jupyter Notebook 1.52% TeX 3.24%
electrostatic-potential ionisation-potential workfunction density-functional-theory vasp semiconductor-physics charge-density

macrodensity's People

Contributors

ajjackson avatar antobi avatar aronwalsh avatar calystat avatar calystates avatar ireaml avatar jarvist avatar liam-harnett avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

macrodensity's Issues

Reference for macroscopic averaging

The lattice_constant setting is the most difficult to understand. Generate a tutorial page and references to the origin of the technique.

IndexError when running macrodensity.py

Hello,

When trying attempting to analyze my LOCPOT file, after running macrodensity.py and PlanarAverage.py, I get the following error:

Traceback (most recent call last):
File "/home/eww9/bin/AvgCharg", line 16, in
vasp_pot, NGX, NGY, NGZ, Lattice = md.read_vasp_density(input_file)
File "/gpfs/home/eww9/bin/macrodensity.py", line 306, in read_vasp_density
Potential[k + m] = inp[m]
IndexError: index 1741825 is out of bounds for axis 0 with size 1741824

I attempted to set NGX, NGY and NGZ in my INCAR file and did a single point calculation (NSW=0) with a converged WAVECAR but this didn't fix the issue. Has anyone else had this issue and resolved it??

Dipole correction

Try to write a routine to correct potentials with an electric field, by applying a dipole correction.

Regarding attribute get_symbol() in Onsitepotential.py

Hi,

When I tried using the code OnSitePotential.py it didn't work. It gave the error atom has no attribute get_symbol().

I had to modify the code slightly to make it run. I used get_chemical_symbols instead. The following is the modified code

coords = ase.io.vasp.read_vasp(coordinate_file)
scaled_coords = coords.get_scaled_positions()
symbols = coords.get_chemical_symbols()
ox_coords = []
i = -1

for atom in coords:
i = i + 1
if symbols[i] == species:
print symbols[i]
ox_coords.append(scaled_coords[i])

Hope this helps anyone trying to use it.

Macroscopic Average Potential

Hello, I am trying to plot the macroscopic average potential using the PlanarAverage.py script but I am not getting the correct average. For instance, the planar average will oscillate and after running the PlanarAverage.py that oscillation will be replaced by a flat line. Could anyone help me with this?

I am trying to create the plot in https://github.com/Anower120/MacroDensity/blob/master/tutorials/HeteroJunction/HeteroJunction.ipynb
with the Planar and Macroscopic averages.

Reduce size of package

The MacroDensity package takes a long time to download. This is primarily due to large LOCPOT files for the examples.

Generate smaller example LOCPOTs to do the same thing with less overhead.

Relax slab structure?

Thanks for developing this package!
I have a question regarding the "Ionisation potential of a bulk material" part: in the slab calculation, should we relax the slab structure, or keep it the same as bulk structure? Might be helpful to clarify in the Tutorial.

Test issue

  1. Guidelines for unscripted testing are available here: http://www.mantidproject.org/Unscripted_Manual_Testing
  2. Comment against this ticket the OS environment you are testing against.
  3. Don't spend more than a few hours on the testing; fatigue will kick in!
  4. If you find errors in the (possibly scant) documentation, please correct them.
  5. Close the this issue once you are done.
    If you find bugs:
  • Search to see if an issue already exists
  • create an issue if it is new
  • Urgent bugs or crashes should by against the current release, and assigned to a developer, then go and talk to the developer if possible.
  • Less urgent bugs should be against a subsequent release, and assigned if the correct developer is known.

Specific Notes:

test stuff

Clean up syntax

There are not many style rules observed in the code. It would be nice to tidy this up before a submission to JOSS.

ToDo: run the source code through and try to check for style conventions, imports of unused functions etc.

unable to install through pip

I am using a MAC OS and with the following command
pip3 install git+git://github.com/WMD-group/MacroDensity.git
I get this error:
Collecting git+git://github.com/WMD-group/MacroDensity.git
Cloning git://github.com/WMD-group/MacroDensity.git to /private/var/folders/m7/7c68by855bq5bn4p89v0jj880000gp/T/pip-req-build-227v2sb0
ERROR: Command errored out with exit status 128: git clone -q git://github.com/WMD-group/MacroDensity.git /private/var/folders/m7/7c68by855bq5bn4p89v0jj880000gp/T/pip-req-build-227v2sb0 Check the logs for full command output.

module 'macrodensity' has no attribute 'points_2_plane'

I was trying to plot electric field in an arbitrary plane. I am getting the error messege
module 'macrodensity' has no attribute 'points_2_plane' when I am running the code PlaneField.py.
Can anybody help me to overcome this issue?

Tests

Build a test suite.

Hank Please

Please introduce Hank's constant to the full release.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.