Release notes
IMPORTANT NOTE: gpaw-tools has evolved and is now called Nanoworks! The gpaw-tools project began as a script that utilized only ASE and GPAW. Over the course of four years, it evolved into a comprehensive suite leveraging multiple libraries, including ASAP3, Phonopy, Elastic, OpenKIM, and now modern Machine Learning Potentials (MACE, CHGNet, SevenNet). Please use Nanoworks for your further studies.
Version 25.10.0
- The -v and -h arguments of
gpawsolve.pywere not working. Fixed. - Many corrections done in
gg.py. It has become outdated for a while. There are many fixes now. They make gg.py run smoothly. Its chronic “stuck while running the simulation” problem is solved now. asapsolve.pycan run with multiple temperatures, multiple frictions, and time steps now.- “examples/ASAP3-Example” is renewed for the new features.
- A basic Quantum Espresso (QE) to gpaw-tools converter script is added.
- A basic VASP to gpaw-tools converter script is added.
- “examples/Si-qe” example is added for
qeconverter.pyscript - “examples/Si-vasp” example is added for
vaspconverter.pyscript - Phonopy calculations were giving errors. Fixed.
Version 25.4.0
- A major change in
elasticcalc(). Now, gpawsolve.py has a working general elastic calculation function! gpawsolve.pynow gives an error message when running without input.
Version 25.2.1
- We forgot to change the version information in the code. So there is no v.25.2.0 :) Please use the corrected v25.2.1 version. Sorry for any inconvenience.
gpaw-toolsis moved to a new repository at https://github.com/sblisesivdin/gpaw-tools. All links in the code are corrected.- Use new notation in BSE calculations.
- RPA is working again.
- BSE calculations are now working without direction. This is a feature downgrade for now.
- Ignore warnings.
- A basic installation script for Ubuntu systems is added. Just run it in the first place.
- Using .fixdensty() in optical calculations.
- Wrong
ang_momvariable usage in a loop is corrected.
Version 24.6.1
- Because the SPGlib dropped the ASE type Atoms object after their version 2.2.0, gpawsolve.py gives an error. From now on, the get_spacegroup() function call will be maintained by ASE. Because of this change, gpawsolve.py no more requires
spglibpackage. - CONTRIBUTING.md file is updated.
Version 24.6.0
- The localisation feature now includes English, Turkish, German, French, Russian, Chinese, Korean, and Japanese.
- Some misleading warning messages are fixed.
- ASE’s
FrechetCellFilteris now used instead ofExpCellFilter. However, this update does not concern back compatibility. Users must use > ASE 3.23 and >GPAW 24.6 after this. nbandsvalue is added to LCAO calculations.Magmom_single_atomkeyword is added.- A new example,
Graphene-charged,is added. Total_chargevariable is added togpawsolve.pyandgg.pyand examples.- A simple language localisation for DOS and Band graphics.
Localisationkeyword is added to all examples - Save the trajectory of Elastic Calculations separately.
Hydrostatic_pressurekeyword is added.- More information about executing the input files has been added to the example files.
- A fix for hybrid calculations. Hybrid calculations will work only for GPAW versions >= 23.10.0
- Calculate spin-dependent charge densities and zeta = (up-down)/(up+down) to CUBE files for both all-electron and pseudo densities.
- The Cr2O example is changed to show new spin-dependent charge density calculations.
- Deprecated argument -r (restart) is removed.
- A base for future projected band structure calculations (not activated now).
Version 23.10.0
- Better -v (version info) message.
- Implementing
GPAW.fixed_density()method corrections for elastic, DOS, and band calculations. - No need for a general benchmark script.
- Correcting log behavior
- Better total and each atom’s PDOS handling. They are written in separate files.
- No need to use ciftoase.py anymore
- Fixing
Ground_kpts_densityandGround_gpts_densityusage sourced DOS calculation error.
Version 23.7.0
- Using dtype as default for PW calculations.
- Drawn DOS and Band figures are aligned with respect to Fermi energy level.
- Implementing autoscale in y-direction for DOS graphs.
- Correcting all possible errors due to gpts and kpts density usage.
- Lowering memory consumption in optical calculations.
- Some examples are changed (Tetrahedron method is used in CrO2 calculations, Bulk-Al calculations are now Bulk-GaAs).
- Using world.size for nblocks in optical RPA calc.
- Updated some calculation default values in both
gpawsolve.pyandgg.py. - Small corrections are done to EXX-related parts, XYYY formatted band result data output, optical RPA calculation, …etc…
- Using
DielectricFunctionwith frequencies. - PW-EXX mode is removed. EXX can be used directly under PW.
- Mostly, no need to use
outdirvariable. However, still can be used. - Phonon calculation feature is added to
gg.py. - Phonopy version information can be viewed when using -v argument.
- Energy consumption measurement with -e argument. This feature only works with Intel CPUs after Sandy Bridge generation. Results are given in kWh!
- Restart -r, –restart argument is now depreceted. There is nothing to be restarted. Instead of -r argument, the new keyword
Ground_calcis introduced. - Basic phonon dispersion calculation feature with Phonopy! At least it works for bulk Al. It is not very mature so please keep this in mind. (Thanks to Michael Lamparski for his help and MIT licensed code that he shared.)
- Save figures in higher dpi.
- Fix some bugs, add new variable and rearrange some variable in
gg.py. - Add Energy_min variable. Energy_min and Energy_max variables are now working on both band and DOS figures.
- Remove unnecessary variables in the input file for the examples/Si-2atoms-optical example.
- Band structure data can be now exported in XYYYY type ASCII file (Thanks to Andrej Kesely).
- Fixed some unused imports and local variables.
- Small fixes at
gg.pyfile. - Adding
struct_from_file()function for future usage. gpawsolve.pyis not only a Python script anymore. The structure of thegpawsolve.pyis rewritten. The calculations are related to a class namedgpawsolve. Also, there are functions related to all possible calculations in this class as:structurecalc(),groundcalc(),elasticcalc(),doscalc(),bandcalc(),densitycalc()andopticalcalc(). The structure is still primitive and code is rely mostly on global variables, however it is a start and it will be easy to use when it finished properly.- From this release “-o” argument is deprecated. Code, all examples and related BASH script are fixed.
Version 23.2.0
- DOS calculation part is changed completely. All calculations for DOS, PDOS and RawPDOS are done with RawPDOS.
- New variable is added:
DOS_convergence. - The variables used in
asapsolve.pyis also changed. From this version,asapsolve.pywill use a special Snake_case (first letter of each variable is capitalized) variables for the input file variables usage.Variable that are affected are: Manualpbc -> Manual_PBC, pbcmanual -> PBC_constraints, PotentialUsed -> OpenKIM_potential, SolveDoubleElementProblem -> Solve_double_element_problem. - Correction of the creating output file that writes spacegroup and special points to a wrong folder.
- Making
do_all_examples.shscript executable. - Wrong usage of GW calculation type in
gg.pyis corrected. - All new variable changes are corrected and new variables are added to
gg.py. simple_benchmark2021.pyis simplified and renamed assimple_benchmark2023.py.- With time,
gpawsolve.pyuses many variables in it and in input files. However, it does not have a proper naming convention for these variables. Also some of the variable names are misleading the user. From this version,gpawsolve.pywill use a special Snake_case (first letter of each variable is capitalized) variables for the input file variables usage. Variables that are affected: mode -> Mode, fmaxval -> Max_F_tolerance, whichstrain -> Relax_cell, cut_off_energy -> Cut_off_energy, kpts_density -> Ground_kpts_dens, kpts_x -> Ground_kpts_x, kpts_y -> Ground_kpts_y, kpts_z -> Ground_kpts_y, gpts_density -> Ground_gpts_dens, gpts_x -> Ground_gpts_x, gpts_y -> Ground_gpts_y, gpts_z -> Ground_gpts_z, Hubbard -> Setup_params, band_path -> Band_path, band_npoints -> Band_npoints, gridref -> Refine_grid energy_max -> Energy_max, GWtype -> GW_type, GWkpoints -> GW_kpoints_list, GWtruncation -> GW_truncation, GWcut_off_energy -> GW_cut_off_energy, GWbandVB -> GW_valence_band_no, GWbandCB -> GW_conduction_band_no, GWppa -> GW_PPA, GWq0correction -> GW_q0_correction, GWnblock -> GW_nblocks_max, GWbandinterpolation -> GW_interpolate_band, opttype -> Opt_calc_type, optshift -> Opt_shift_en, optBSEvb -> Opt_BSE_valence, optBSEcb -> Opt_BSE_conduction, optBSEminEn -> Opt_BSE_min_en, optBSEmaxEn -> Opt_BSE_max_en, optBSEnumdata -> Opt_BSE_num_of_data, num_of_bands -> Opt_num_of_bands, optFDsmear -> Opt_FD_smearing, opteta -> Opt_eta, optdomega0 -> Opt_domega0, optomega2 -> Opt_omega2, optecut -> Opt_cut_of_energy, optnblocks -> Opt_nblocks, MPIcores -> MPI_cores find3Dmin.pyA script which draws 3D contour plot of E vs. latticeparams and show the minimum datapoint using the optimize_latticeparam.py’s output, is added.
Version 22.7.0
optimize_latticeparam.pynow can work for both lattice params a and c. Also draws 3D fig of Energy dependent latt_a - latt_c.quickoptimize.pyworks likegpawsolve.pynow. Its name is nowasapsolve.py.- New default optimizer is QuasiNewton (BFGSLineSearch).
- New keyword
Optimizer. Users can now choose QuasiNewton, GPMin, LFBGS or FIRE minimizer for geometry optimization. gg.pyincludes all new keywords.- Grid point density or manual grid points for axis (LCAO only).
- Include new keywords for LBFGS geometry optimization
Damping,AlphaandMax_step. Geo_optimkeyword for better optimization usage with filters (whichstrain).- Examples are simplified. Most of the unnecessary keywords are removed.
- Proper logging for LCAO ground state calculations
- Fix LCAO spinpol calculation (Thanks to Toma Susi).
- Include new keyword
Mixer_type. - Fix help description text width problem.
- Execution timing data of all calculations are saved to
FILENAME-6-Result-Log-Timings.txtfile. - Instead of direct execution, all tasks are added to task-spooler queue in
do_all_examples.shscript.
Version 22.5.0
- Successful HSE03, HSE06 calculations for ground state, DOS and band structure.
- New example for HSE06 calculations:
Si-with-HSE. - Colorize errors, warnings and information output with ANSI codes.
- Proper error handling for restart mode “file not found” error.
- New keyword
Fix_symmetryadded togpawsolve.py,gg.pyfor preserving the spacegroup symmetry during optimisation. - Small changes in the
gg.py - No need to import ASE object inside optimization scripts. Optimizations are working with CIF files only.
gpawsolve.pynow prints previous and final spacegroup information and usable special points information for band structure calculations.-vargument now shows version information of gpaw-tools, and used GPAW, and ASE. It gives more choice for possible tarball and zipball packages. Also, it does not give an error in case of no internet connection available.- 3 new keywords
Ground_convergence,Band_convergenceandOccupationare added togpawsolve.py,gg.pyand examples. - Fix
do_all_examples.shBash script. - Optimization scripts do not need ASE object insertation. They can run with using CIF file as an argument.
- RawPDOS, which gives PDOS over orbitals, is added.
- For band calculations, result file in JSON format is added. This file can be opened with
ase band-structurecommand.
Version 22.4.0
- New optimization script
optimize_kptsdensity.pyfor k-point density optimization instead of k-point number optimization. optimize_cutoff.py,optimize_kpoints.pyandoptimize_latticeparam.pyhavexc_usedin parameters list.- Naming of some of the output files are fixed.
- Bethe-Salpeter Equation (BSE) solution is added to optical calculations.
- 7 new keywords are added for BSE calculations.
opttype,optshift,optBSEvb,optbsecb,optBSEminEn,optBSEmaxEn,optbsenumdata Si-2atoms-opticalexample is now running for both RPA and BSE. Previously, its calculation has 2 steps , now 3 steps.- CONTRIBUTING and CODE_OF_CONDUCT information is added.
- Fix: Show atom numbers starting from 1 not 0.
Version 22.3.0
- New calculation: with
Elastic_calc=True, Equation of State and elastic tensor values will be calculated. Elastic_calcis added togg.py.- A new example about elastic calculations is added.
- Many comments added to
gg.pyfor better understanding the code. DOS_npointsandDOS_widthvariables are added for number of points and smearing value, respectively.- Saving PNG versions of band structure and DOS even in -d argument is not used.
shrinkgpw.pycommand for extracting wavefunctions from huge gpw files and save with a different name.- New benchmarks were added.
Version 21.12.0
- EXX mode is renamed as PW-EXX.
- Default values of variables are changed.
- Previous -i (input) argument is changed as -g (geometry). It is more logical, because it is used for geometry.
- Previous -c (config) argument is changed as -i (input). It is more general, convenient and understandable.
gg.pycan now work with just enough number of variables. Previously, it must see all variables.kpts_densityis added.- Units used in cube file are changed for Bader analysis.
- There is no general config file anymore.
- Small bugfixes.
Version 21.11.0
- PDOS calculations.
- PW mode can use GLLB-SC xc now.
optimize_cutoff.pyandoptimize_kpoints.pycan use CIF, XYZ, etc… files as input file. No need to include the ASE object inside these scripts anymore.- The nbands parameter is changed in PW mode.
- In GW calculations, calculation could not be done because of interpolation in drawing the figure when the data did not have a minimum of 3 points. Now there is a variable to use interpolation or not.
- In GW calculations,
gpawsolve.pycan write quasiparticle energies to a file separately. - DFT+U calculation ability is added for PW and LCAO modes.
gg.pyis better now. It is compatible with new arguments and removed variables. It can run in any directory and handling ofGWkpointsandGWtruncationvariables are correct now.- A new argument ‘-d’ is added. This argument makes script draw the DOS and band calculation results. In the past, it was a varible in the config file.
WantedCIFexportvariable is removed.- A new argument ‘-r’ is added. This argument makes script pass the ground state calculations and continue with the next calculation.
Version 21.10.1
- An important bug made it impossible to work with existing examples with
gg.py. It is now resolved.
Version 21.10.0
- 5 different examples are added to show simply different usage cases.
- Initializing magnetic moment problem is solved.
- Version argument is added.
- GW parameters are also added to
gg.py - Add some optical parameters to config files and
gg.py. - Major change:
gpawsolve.pyandgg.pyare now working as commands. Config files can be used as general input files, you can put ASE Atom object plus every parameter thatgpawsolve.pyaccepts. If you want, you can provide a CIF file instead of using an atom object. You can rungpawsolve.pyandgg.pyfrom any folder. - Optical: Refractive index, extinction index, absorption, and reflectivity calculations.
gg.pyis now opening ase gui when the user clicks the structure image.- New argument parsing scheme for better future usages.
- Very basic PW-EXX mode with HSE06 and PBE06. (Only some ground-state calculations.)
- Adding GW0 and G0W0-GW0 selector.
- Adding GW approximation to
gpawsolve.py(only bands). - Many other small corrections.
Version 21.9.0
- Corrected
quickoptimize.pybehaviour. - Many code quality and folder structure improvements.
- Comment additions to code.
- Better README.md.
gg.pywhich is a GUI for gpaw-tools is added to project. It can do allgpawsolve.py’s features in a graphical way!gpawsolve.pycan be run solely as a command now (This is needed for a GUI project).- All three scripts
PW-Electronic.py,LCAO-Electronic.pyandPW-Optical-SingleCoreOnly.pyscripts becomes a single for-all-case script:gpawsolve.py. PW-Electronic-changename.pyscript becomesPW-Electronic.py.- Spin-polarized results in
PW-Electronic-changename.pyscript. - All-electron density calculations in
PW-Electronic-changename.py. - CIF Export in
PW-Electronic-changename.pyscript. - Better parallel computation.
- Several XCs available for PW.
LCAO-Electronic.pyscript.- Strain minimization in PW only.
- BFGS to LBFGS, Small many changes have been done.
Preversion
PW-Optical-SingleCoreOnly.pyscript for optical calculations.PW-Electronic-changename.pyscript for electronic calculations.- First scripts for personal usage.