## Release Notes

### Development Version

- n/a

### Version 26.2.0 - Feb 1, 2026 (The first nanoworks version)

- Initializing context and tools for the session.
- Removed `gg.py` and gui_files/ directory.
- Renaming project and its files as: `gpaw-tools` -> `Nanoworks`, `gpawsolve.py` -> `dftsolve.py`, and `asapsolve.py` -> `mdsolve.py`.
- Replace the `gpaw-tools` setup with the `Nanoworks` setup
- Implement an ML solver script: `mlsolve.py`
- Remove GW calculations and related parameters from `dftsolve.py`
- Simplify GPW file writing logic (Always mode="all")
- A major refactorization of global variable usage to dataclass! This change ensures type safety, centralized configuration, reduced global namespace pollution, and improved code organization with total backward compatibility.
- In addition to the refactorization of global variable usage, more than 30 security warnings have been fixed.
- An easy example for machine learning capabilities is added as examples/Graphene-ML
- Behavior of output folder creation and writing in that directory is now the same for `dftsolve.py`, `mdsolve.py`, and `mlsolve.py`.
- Drawing to screen argument "-d" is removed.
- `pip install nanoworks` works.
- Website is moved to [https://nanoworks.readthedocs.io](https://nanoworks.readthedocs.io)
- `dftsolve.py`: works as a system-wide command `dftsolve`.
- `mdsolve.py`: works as a system-wide command `mdsolve`.
- `mlsolve.py`: works as a system-wide command `mlsolve`.
- New command: `nanoworks` command is added. Just giving important information for now.
- All keywords for `dftsolve`, `mdsolve` and `mlsolve` are rewritten for better representation on webpage
- `mlsolve` is working with input files from now on, not with a Python dictionary.
- New `install_scripts` directory.
- Version information is taken from `__init__.py` for all commands.
- Better installation and usage guides.
- New argument for `dftsolve`: -p for parallel processing. Without using gpaw -P or mpirun -np arguments, users can run parallel processing with this new argument.
- New argument for `dftsolve`: -a for auto mode. It is working with only geometry file, runs ground, dos and band calculations and create an input file for future needs.
- Add timing calculation to elastic calculations.
- Change all output file naming scheme.

### Version 25.10.0 - Oct 1, 2025 (The last gpaw-tools version)

* The -v and -h arguments of `gpawsolve.py` were 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.py` can 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.py` script
* "examples/Si-vasp" example is added for `vaspconverter.py` script
* Phonopy calculations were giving errors. Fixed.

### Version 25.4.0 - Apr 18, 2025

* A major change in `elasticcalc()`. Now, gpawsolve.py has a working general elastic calculation function!
* `gpawsolve.py` now gives an error message when running without input.

### Version 25.2.1 - Feb 3, 2025

* 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-tools` is moved to a new repository at [https://github.com/sblisesivdin/gpaw-tools](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_mom` variable usage in a loop is corrected.

### Version 24.6.1 - Jun 10, 2024

* 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 the `spglib` package.
* CONTRIBUTING.md file is updated.

### Version 24.6.0 - Jun 5, 2024

* The localisation feature now includes English, Turkish, German, French, Russian, Chinese, Korean, and Japanese.
* Some misleading warning messages are fixed.
* ASE's `FrechetCellFilter` is now used instead of `ExpCellFilter`. However, this update does not concern back compatibility. Users must use > ASE 3.23 and >GPAW 24.6 after this. 
* `nbands` value is added to LCAO calculations.
* `Magmom_single_atom` keyword is added.
* A new example, `Graphene-charged,` is added.
* `Total_charge` variable is added to `gpawsolve.py` and `gg.py`, and examples.
* A simple language localisation for DOS and Band graphics. `Localisation` keyword is added to all examples
* Save the trajectory of Elastic Calculations separately.
*  `Hydrostatic_pressure` keyword 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 - Oct 13, 2023

* 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_density` and `Ground_gpts_density` usage sourced DOS calculation error.

### Version 23.7.0 - Jul 4, 2023

* Using dtype as default for PW calculations.
* Drawn DOS and Band figures are aligned with respect to the Fermi energy level.
* Implementing autoscale in the 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.py` and `gg.py`.
* Small corrections are done to EXX-related parts, XYYY formatted band result data output, optical RPA calculation, etc.
* Using `DielectricFunction` with frequencies.
* PW-EXX mode is removed. EXX can be used directly under PW.
* Mostly, no need to use `outdir` variable. However, it can still be used.
* Phonon calculation feature is added to `gg.py`.
* Phonopy version information can be viewed when using the -v argument.
* Energy consumption measurement with -e argument. This feature only works with Intel CPUs from the Sandy Bridge generation onward. Results are given in kWh!
* Restart -r, --restart argument is now depreceted. There is nothing to be restarted. Instead of the -r argument, the new keyword `Ground_calc` is introduced.
* Basic phonon dispersion calculation feature with Phonopy! At least it works for bulk Al. Please keep this in mind, as it is not very mature. (Thanks to Michael Lamparski for his help and MIT-licensed code that he shared.)
* Save figures in higher dpi.
* Fix some bugs, add a new variable, and rearrange some variables 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 now be exported in XYYYY type ASCII file (Thanks to Andrej Kesely). 
* Fixed some unused imports and local variables.
* Small fixes in the `gg.py` file.
* Adding `struct_from_file()` function for future usage.
* `gpawsolve.py` is not only a Python script anymore. The structure of the `gpawsolve.py` is rewritten. The calculations are related to a class named `gpawsolve`. Also, there are functions related to all possible calculations in this class as `structurecalc()`, `groundcalc()`, `elasticcalc()`, `doscalc()`, `bandcalc()`, `densitycalc()`, and `opticalcalc()`. The structure is still primitive, and code relies mostly on global variables; however, it is a start, and it will be easy to use when it is finished properly.
* From this release "-o" argument is deprecated. Code, all examples, and the related BASH script are fixed.

### Version 23.2.0 - Feb 1, 2023

* The DOS calculation part is changed completely. All calculations for DOS, PDOS, and RawPDOS are done with RawPDOS.
* A new variable is added: `DOS_convergence`.
* The variables used in `asapsolve.py` are also changed. From this version, `asapsolve.py` will use special Snake_case (first letter of each variable is capitalized) variables for the input file variable usage.Variable that are affected are: *Manualpbc -> Manual_PBC, pbcmanual -> PBC_constraints, PotentialUsed -> OpenKIM_potential, SolveDoubleElementProblem -> Solve_double_element_problem.*
* Correction of the output file that writes spacegroup and special points to the wrong folder.
* Making `do_all_examples.sh` script executable.
* Wrong usage of GW calculation type in `gg.py` is corrected.
* All new variable changes are corrected, and new variables are added to `gg.py`.
* `simple_benchmark2021.py` is simplified and renamed as `simple_benchmark2023.py`.
* With time, `gpawsolve.py` uses many variables in it and in the 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.py` will use a special Snake_case (first letter of each variable is capitalized) variable for the input file variable 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.py` A script which draws a 3D contour plot of E vs. latticeparams and shows the minimum datapoint using the optimize_latticeparam.py's output, is added.

### Version 22.7.0 - Jul 12, 2022

* `optimize_latticeparam.py` now can work for both lattice params a and c. Also draws 3D fig of Energy dependent latt_a - latt_c.
*  `quickoptimize.py` works like `gpawsolve.py` now. Its name is now `asapsolve.py`. 
* New default optimizer is QuasiNewton (BFGSLineSearch).
* New keyword `Optimizer`. Users can now choose QuasiNewton, GPMin, LFBGS, or FIRE minimizer for geometry optimization. 
* `gg.py` includes all new keywords.
* Grid point density or manual grid points for axis (LCAO only).
* Include new keywords for LBFGS geometry optimization: `Damping`, `Alpha`, and `Max_step`.
* `Geo_optim` keyword 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 the `FILENAME-6-Result-Log-Timings.txt` file.
* Instead of direct execution, all tasks are added to the task-spooler queue in `do_all_examples.sh`script.

### Version 22.5.0 - May 8, 2022

* 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 the restart mode "file not found" error. 
* New keyword `Fix_symmetry` added to `gpawsolve.py`, `gg.py` for 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.py` now prints previous and final spacegroup information and usable special points information for band structure calculations.
* `-v` argument now shows version information of gpaw-tools, and used GPAW, and ASE. It gives more choices 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_convergence`, and `Occupation` are added to `gpawsolve.py`, `gg.py`, and examples.
* Fix `do_all_examples.sh` Bash script.
* Optimization scripts do not need ASE object insertion. They can run using a CIF file as an argument.
* RawPDOS, which gives PDOS over orbitals, is added.
* For band calculations, the result file in JSON format is added. This file can be opened with the `ase band-structure` command.

### Version 22.4.0 - Apr 7, 2022

* New optimization script `optimize_kptsdensity.py` for k-point density optimization instead of k-point number optimization.
* `optimize_cutoff.py`, `optimize_kpoints.py` and `optimize_latticeparam.py` have `xc_used` in parameters list.
* The naming of some of the output files is 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-optical` example is now running for both RPA and BSE. Previously, its calculation had 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 - Mar 4, 2022

* New calculation: with `Elastic_calc=True`, Equation of State and elastic tensor values will be calculated.
* `Elastic_calc` is added to `gg.py`.
* A new example about elastic calculations is added.
* Many comments added to `gg.py` for better understanding of the code.
* `DOS_npoints` and `DOS_width` variables are added for the number of points and smearing value, respectively.
* Saving PNG versions of band structure and DOS even in the -d argument is not used.
* `shrinkgpw.py` command for extracting wavefunctions from huge GPW files and saving with a different name.
* New benchmarks were added.

### Version 21.12.0 - Dec 2, 2021

* EXX mode is renamed as PW-EXX.
* Default values of variables are changed.
* Previous -i (input) argument is changed to -g (geometry). It is more logical, because it is used for geometry.
* Previous -c (config) argument is changed to -i (input). It is more general, convenient, and understandable.
* `gg.py` can now work with just enough variables. Previously, it must see all variables.
* `kpts_density` is added.
* Units used in the cube file are changed for Bader analysis.
* There is no general config file anymore.
* Small bugfixes.

### Version 21.11.0 - Nov 2, 2021

* PDOS calculations.
* PW mode can use GLLB-SC xc now.
* `optimize_cutoff.py` and `optimize_kpoints.py` can use CIF, XYZ, etc, files as input files. No need to include the ASE object inside these scripts anymore.
* The nbands parameter is changed in PW mode.
* In GW calculations, the 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.py` can write quasiparticle energies to a file separately.
* DFT+U calculation ability is added for PW and LCAO modes.
* `gg.py` is better now. It is compatible with new arguments and removed variables. It can run in any directory, and handling of `GWkpoints` and `GWtruncation` variables are correct now.
* A new argument '-d' is added. This argument makes the script draw the DOS and band calculation results. In the past, it was a variable in the config file.
* `WantedCIFexport` variable is removed. 
* A new argument '-r' is added. This argument makes the script pass the ground state calculations and continue with the next calculation.

### Version 21.10.1 - Oct 1, 2021

* An important bug made it impossible to work with existing examples with `gg.py`. It is now resolved.

### Version 21.10.0 - Oct 1, 2021

* 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.py` and `gg.py` are now working as commands. Config files can be used as general input files; you can put an ASE Atom object plus every parameter that `gpawsolve.py` accepts. If you want, you can provide a CIF file instead of using an atom object. You can run `gpawsolve.py` and `gg.py` from any folder.
* Optical: Refractive index, extinction index, absorption, and reflectivity calculations.
* `gg.py` is 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 - Sep 14, 2021

* Corrected `quickoptimize.py` behaviour.
* Many code quality and folder structure improvements.
* Comment additions to code.
* Better README.md.
* `gg.py` which is a GUI for gpaw-tools is added to project. It can do all `gpawsolve.py`'s features in a graphical way!
* `gpawsolve.py` can be run solely as a command now (This is needed for a GUI project).
* All three scripts`PW-Electronic.py`, `LCAO-Electronic.py` and `PW-Optical-SingleCoreOnly.py` scripts becomes a single for-all-case script: `gpawsolve.py`.
* `PW-Electronic-changename.py` script becomes `PW-Electronic.py`.
* Spin-polarized results in `PW-Electronic-changename.py` script.
* All-electron density calculations in `PW-Electronic-changename.py`.
* CIF Export in `PW-Electronic-changename.py` script.
* Better parallel computation.
* Several XCs available for PW.
* `LCAO-Electronic.py` script.
* Strain minimization in PW only. 
* BFGS to LBFGS, many changes have been made.

### Preversion
* `PW-Optical-SingleCoreOnly.py` script for optical calculations.
* `PW-Electronic-changename.py` script for electronic calculations. 
* First scripts for personal usage.