Feature documentation #46
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…nce of exciton quantities
…so /%end does not work for all qe versions, tested and fixed
- Added support for plasmon-pole ndb.pp* databases (yambopy will automatically detect them and extract the static part if ndb.em1s is not found) - Added support for direction-dependent q-plots (by supplying the indices of a subset of q-vectors in _getepsq and _getem1s)
2) Possibility to plot the reconstructed polarization
…er of types actually used and correctly reads the SAVE. - Implemented support for loading dipoles for OPEN-SHELL systems. Beware: the spin-polarised optical absorption plots in the open-shell case is UNTESTED.
- Mainly merged support for reading dipoles in open-shell systems
Bug Fix bsekerneldb
- Importing bug fix to bsekerneldb by R. Reho
Improvements in non-linear analysis
- Updates in non-linear postprocessing (by C. Attaccalite)
Bug fix PW.py
- Imported patch on handling QE input files by R. Reho
|
I was thinking that I could start merging this branch since it affects only the docs/ directory that was previously broken anyway, so this is a net positive even if it is a work in progress. We can have our separate doc branches and when we have updates we do a pull request here. It is also ok to start adding the sphinx dependency. What do you think? |
|
I think it's a good idea to have a main-doc branch and create sub-branch for specific tutorials. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related to issue #45 and #40.
I create a new branch for documentation.
I added (only for this branch) the pip dependencies for
sphinxandsphinx-rtd-themealong with tutorials files insidedocsfolder.If you go to the
docsfolder, it should be enough to run simplymake htmland it will produce the the.htmlfiles indocs/build/html.I added to this branch a small tutorial on the lifetimes which show how to get their values. The text is in
docs/source/tutorial.rst.