From 458e3f5c06a36b57e45dc6ecae8705af5223c05a Mon Sep 17 00:00:00 2001 From: Dou Du Date: Wed, 17 Jul 2024 11:18:13 +0800 Subject: [PATCH] update README.md file for #61 --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9005c81..3dd4f6c 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ verdi data band export --format=json ``` One can plot several band structure input files together with the widget. -The format of the DOS input dict is validate by the [PDOS Schema](https://raw.githubusercontent.com/osscar-org/widget-bandsplot/main/widget_bandsplot/schemas/pdos.json), the exampla valid input is: +One exampla valid input is: ```python dos_data = { @@ -72,14 +72,14 @@ dos_data = { ### 2. Plot only the band structure ```python -w = BandsPlotWidget(bands=[banddata1, banddata2], plot_fermilevel = True, show_legend = True, energy_range = [-10,10]) +w = BandsPlotWidget(bands=[banddata1, banddata2], format_settings = {"plotFermil": True, "showLegend": True}, energy_range = [-10,10]) display(w) ``` ### 3. Plot only the density of states (DOS) ```python -w = BandsPlotWidget(dos=dosdata, plot_fermilevel = True, show_legend = True, energy_range = [-10, 10]) +w = BandsPlotWidget(dos=dosdata, format_settings = {"plotFermil": True, "showLegend": True}, energy_range = [-10, 10]) display(w) ```