From 50a6f4bad02cc1aa7f796cf2737b48a47cfdab2c Mon Sep 17 00:00:00 2001 From: Louis Ponet Date: Thu, 20 Apr 2023 17:00:27 +0200 Subject: [PATCH] fixed documentation --- README.md | 1 + docs/src/guide/basic_tutorial.jl | 5 +---- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 07e49ad7..32ef5d89 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,7 @@ [![Coverage Status](https://coveralls.io/repos/github/louisponet/DFControl.jl/badge.svg?branch=master)](https://coveralls.io/github/louisponet/DFControl.jl?branch=master) [![](https://img.shields.io/badge/docs-stable-blue.svg)](https://louisponet.github.io/DFControl.jl/stable) [![](https://img.shields.io/badge/docs-latest-blue.svg)](https://louisponet.github.io/DFControl.jl/dev) +[![Package Downloads](https://shields.io/endpoint?url=https://pkgs.genieframework.com/api/v1/badge/DFControl)](https://pkgs.genieframework.com?packages=DFControl) This package is a tool to interact with DFT related packages. Currently best support is for Quantum-Espresso and WANNIER90. The support for Abinit is highly experimental and will get updated very soon. diff --git a/docs/src/guide/basic_tutorial.jl b/docs/src/guide/basic_tutorial.jl index aee4ea06..ca23b05e 100644 --- a/docs/src/guide/basic_tutorial.jl +++ b/docs/src/guide/basic_tutorial.jl @@ -26,10 +26,7 @@ end#hide # QE is installed, and to be found in the `/opt/qe/bin`, change this according to your own # setup. The first argument to the constructor can be used as a label to later retrieve the executable after it was saved. -pw_exec = Exec(name="pw", exec="pw.x", dir="/opt/qe/bin/", flags=Dict("-nk" => 4)) - -# Additional executable flags can be passed as varargs to the constructor of `Exec`, -# e.g. `Exec("pw.x", "/opt/qe/bin/", :nk => 4, :ndiag => 2)`. +pw_exec = Exec(name="pw", path="/opt/qe/bin/pw.x",flags=Dict("-nk" => 4)) # Then we create the first calculation for our job, we name it scf, which will be used to reference it later. # We also pass the executables to be used and additional flags to be set to the constructor.