Git Product home page Git Product logo

bgwpy's Introduction


A python module to operate BerkeleyGW

Documentation

We recommend learning the basic usage from the examples provided with the source distribution in ~BGWpy/Examples/. The docstrings of the various objects also contain information and can be accessed from a python interpreter with

help(BGWpy.<object>)

or from ipython with

In  [1]: BGWpy.<object>?

Requirements

The following software and modules are required to use BGWpy.

Note that the binary executables of BerkeleyGW must be found in your PATH environment variable.

Installing

Automatic installation:

python -m pip install BGWpy

Manual installation: once you have satisfied the requirements, install the package with

python setup.py install

Whether you install automatically of manually, you should run the script BGWpy_make_config_file.py to generate a runtime configuration file ~/.BGWpyrc which you can then modify. Most options in this file represent default values, and can be overridden when using the module.

License

This software is free to use under the BSD license. See license.txt for more information.

bgwpy's People

Contributors

gkantonius avatar jonahhaber avatar jornada 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

Watchers

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

bgwpy's Issues

Provide Jupyter Notebook Example

The example scripts for BGWpy are currently bash scripts. While I'm perfectly comfortable with terminal scripts, I'm an old man, and the kids love their Jupyter Notebooks.

A Jupyter Notebook for BGWpy should be added to the documentation, which can be run from start-to-finish for a reasonably generic system (no fancy qsubs or apruns).

A preliminary version of this exists as a GitHub Page at https://wphuhn.github.io/site/index.html, but it needs some spicing up. Some plotting with matplotlib + seaborn, perhaps an example of using scikit-learn to fit an ML model since the kids also love overfitting models.

Add Runtime Options to Set All User Configuration Variables

Currently, BGWpy has a config/user_configuration.py file which must be created by the user during package installation to set values for certain runtime variables related to the user's local environment. While some of the variables in this file can be overriden at runtime, e.g. default_mpi, others cannot be overridden through the public API, e.g. use_hdf5.

We have received requests to start distributing BGWpy through package managers (conda, pip); however, the requirement of a user-created config/user_configuration.py file means that BGWpy can not be installed in the automated fashion necessary for a package manager.

One way to circumvent this problem is to allow the user to override all variables set in config/user_configuration.py at runtime through the public API. This would allow us to have a default configuration file that could be used during automated install, which the user could override at runtime to correspond to their local environment.

How to run Wannier90 in BGWpy?

Hello,

After doing all GW calculations using BGWpy scripts smoothly, I want to use Wannier90 to plot band structures and DOS.

I found a difficulty to define the variables used with Wannier90, such as: nwann, kbounds, klabels, projections,.....

Could you please add a python script showing how to use Wannier90?

Thanks,

Ragab.

HDF5 Support in Quantum ESPRESSO

Currently, when installing BGWpy with HDF5 support, it will set up the appropriate symbolic links for BerkeleyGW calculations using HDF5 filenames, e.g. epsmat.h5 instead of epsmat.

However, BGWpy will set up the symbolic links for Quantum ESPRESSO calculations using non-HDF5 filenames, i.e. charge-density.dat instead of charge-density.hdf5.

This behaviour is unexpected, and BGWpy should use HDF5 for Quantum ESPRESSO as well as BerkeleyGW when it is installing with HDF5 support.

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.