Giter Club home page Giter Club logo

jageo / lobsterpy Goto Github PK

View Code? Open in Web Editor NEW
66.0 1.0 27.0 129.85 MB

Package to perform automatic bonding analysis with the program Lobster in the field of computational materials science and quantum chemistry

Home Page: https://jageo.github.io/LobsterPy/

License: BSD 3-Clause "New" or "Revised" License

Python 98.48% TeX 1.52%
computational-chemistry plotting chemical-bonding materials-informatics python computational-materials-science

lobsterpy's Introduction

Hi there πŸ‘‹

πŸ‘©β€πŸ”¬ I am a permanent researcher and junior group leader at the Federal Institute for Materials Research and Testing (Bundesanstalt fΓΌr Materialforschung und -prΓΌfung) in Berlin, Germany, and I develop code to do materials science. Since September 2023, I am also a Professor for Materials Informatics at FSU Jena (https://www.uni-jena.de/).

βš›οΈ I am searching for new materials with desired properties for thermoelectric materials, solar cells and batteries. I aim at understanding materials properties with the help of bonding analysis (🦞) and coordination environments. For example, I have recently assessed the predictive power of the Pauling rules. We have also developed a code to automatically perform bonding analysis: LobsterPy 🦞🐍.

πŸ‘©β€πŸ’» I have contributed to pymatgen, custodian, atomate, and atomate2. I am currently part of the Materials Project Software Foundation. I have also developed some smaller packages to analyse phonons.

πŸ“ƒ You can find a list of my publications here.

πŸ’» My website contains more info. And, you can find me on Mastodon, Twitter and LinkedIn

πŸ”₯ My Stats:

My Awesome Stats

lobsterpy's People

Contributors

ajjackson avatar berquist avatar dependabot[bot] avatar jageo avatar jonasgrandel avatar kaueltzen avatar naik-aakash avatar pre-commit-ci[bot] avatar quantumchemist avatar rmeli 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

Watchers

 avatar

lobsterpy's Issues

question

Describe the bug
when i run lobsterpy automatic-plot --allbonds
it reported
/data/software/anaconda/2020.07/envs/lobsterpy/lib/python3.8/site-packages/pymatgen/electronic_structure/cohp.py:164: UserWarning: This method has not been tested on many examples. Check the parameter limit, pls!
warnings.warn("This method has not been tested on many examples. Check the parameter limit, pls!")
The compound CrN has 1 symmetry-independent atoms(s) with relevant bonds: Cr1.
Cr1 has a single (CN=1) coordination environment. It has 1 Cr-Cr (mean ICOHP: -0.2 eV, antibonding interaction below EFermi) bonds.

what does it mean ? the Cr-Cr is anti bonding? but i cannot seen it in my picture. And it did not generate any output? How can I do with it.I asked before, but I didn't check the reply in time. I'm very sorry to ask again

Documentation/Tutorial

A tutorial with the basic functions of lobsterpy might be useful for users that have never done a Lobster computation.

Update readme

We need to update the installation process description in the readme.

some error

Hi,
when I run lobsterpy automatic-plot ,it reported as followed,
/data/software/anaconda/2020.07/envs/lobsterpy/lib/python3.8/site-packages/pymatgen/electronic_structure/cohp.py:164: UserWarning: This method has not been tested on many examples. Check the parameter limit, pls!
warnings.warn("This method has not been tested on many examples. Check the parameter limit, pls!")
and it did not generate any results.How can solve the problem.thanks
zhou chao

Test speed-up

As the tests are currently taking forever to run, we (@naik-aakash) should probably also look into speeding up the tests and linting. I had in mind to maybe also switch to a ruff linter.

plotting DOS or COXX not possible with latest lobsterpy version

Describe the bug
when plotting things with lobsterpy via lobterpy autoplot or lobsterpy plotdos, the following error is thrown:
OSError: '/home/certural/miniconda3/envs/atomate2/lib/python3.10/site-packages/lobsterpy/plotting/lobsterpy_base.mplstyle' not found in the style library and input is not a valid URL or path; see style.available for list of available styles

To Reproduce
e.g. lobsterpy plotdos

Expected behavior
Plotting nice plots

PS: this issue is more for documentation @naik-aakash is already working on a fix :)

Some train πŸš‚ thoughts

Recently with the new and temporary students (that are also rather inexperienced with using cli etc.) I think a lot about user friendliness. So I thought maybe it is a good idea to have a default functionality for each lobsterpy feature e.g. lobsterpy plotdos will automatically do something like lobsterpy plotdos --elements [list of atoms from POSCAR] instead of throwing an error. The default should be chosen in a way to get most out of it with minimum complexity (e.g. in case of the DOS plotting elementwise DOS is more common than plotting orbitalwise DOS and also maybe easier to comprehend for beginners (I'm not sure about the last part, but when I learned this stuff a good while ago, this was true for me)).
Since I try to improve my programming skills in python (and C++) anyways by doing exercises on the weekend or so, I thought maybe I could implement it the next WE, if you (@JaGeo and @naik-aakash) are ok with this?

clean up cli argparse

Currently, lot of not necessary arguments show up for differnent possible actions. Could be cleanup a bit by regrouping the args

Increase test coverage cli.py

There are a few lines in the cli.py that are not yet covered by tests including

        if args.addtotaldos:
            dos_plotter.add_dos(dos=lobs_dos, label="Total DOS")

)
Maybe, we could address this.

Skip showing of plots in automatic analysis

Is your feature request related to a problem? Please describe.
For large structures, there should be the option to skip the showing of the plots and only the save option should be used.

This has to be tested and also added to command line tools.

Orbital resolved data in featurizer

Add possibility to obtain orbital-resolved features in featurizer . Should be useful to get data for orbital interaction diagrams as well

  • COXX fingerprints
  • COXX center, width, skew, kurtosis

calc_quality_summary : dict keys needs to follow snakecase and some renaming

Currently not all keys do not have snake_case convention: got over looked in paper

As lot of things are changed compared to our publication, maybe better to fix them now itself.

Also for example some keys like : charges and bandoverlaps could be renamed to be bit more descriptive as our larger schema already same keys with different data in it on top level

What do you think @JaGeo ?

Code-agnostic automatic analyisis

It would be good to get our automatic analysis working for QE and Abinit outputs as well.

@davSchnieders, it would be great if you could provide a sample output. We could then make automatic analysis work for QE as well.

update test durations files

After merging all the PRs and reorganizing test files, update the old test durations files for optimized pytest runs

Add more bond options

Add all potential options for bonds that are also available in pymatgen:

e.g., only cation-cation bonds

Orbital-resolved automatic analysis

Is your feature request related to a problem? Please describe.
I would like to implement an automatic analysis including orbital-resolved interactions. I will add this as an additional option so that people can also skip the orbital-resolved analysis.

I hope to accomplish this in the next 4 weeks.

Inspection for lobsterout

Add something to inspect a lobsterout and other lobsteroutputs so that user's can be confident about their lobster results.

Easy lobsterin generation

Add an option to the commandline to generate lobsterin and compute number of bands based on a POSCAR and POTCAR file. Doing this via pymatgen or within atomate is currently a bit labor-intensive.

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.