Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

V2.0 **BREAKING CHANGES** #30

Merged
merged 20 commits into from
Mar 29, 2022
Merged

V2.0 **BREAKING CHANGES** #30

merged 20 commits into from
Mar 29, 2022

Conversation

kbspooner
Copy link
Collaborator

Breaking changes:

  • axes module is now tp.axes.size.size.number_description, legend is omitted from description and all functions return an add_legend argument. Several functions have been combined, and several new ones have been added.

  • add_legend now accepts a location argument, for keywords like above or right, and also integers to represent loc=best inside each axis (distinct from just loc=best as it still combines all legends).

  • alphabetise function in axes.legend to alphabetise or enumerate axes, including presets, but also fully customisable.

  • command-line interface changed to click, syntax is now tp group function arguments, see docs for more details.

New functionality:

  • setup module which currently deals with setting up VASP KPOINTS files, including zero-weighted k-points, which help AMSET and also BoltzTraP run efficiently.
  • Line plots at the command line (electronic transport properties, kappa and amset scattering rates.
  • Heatmap plots for power factor, and the difference between two zts/ power factors.
  • Data retrieval functions at the command line.

Miscellaneous:

  • Revamped documentation
  • Tutorialised examples
  • Robustified resolve and add_legend functions
  • Updated testing
  • Numerous bug fixes and performance improvements

Kieran B Spooner and others added 20 commits June 1, 2021 15:05
typo in tp.calculate.dfdde
so far generates zero-weighted kpoints to make amset run faster
(among other uses), and suggests KPAR values for your calculations.
learing about click
also improved cusomisability of some plots and made most except
clauses more specific, also bug fixes
also enhanced and streamlined colour parsing with
tp.plot.utilities.parse_colours and bug fixes
Added line graphs to the CLI.

Added data retrieval commands to the CLI.

Generalised resolve.py to work so long as the dimensions are given
in the metadata.

Now reads phono3py direction data as a 3x3 array rather than a 6x1
array for consistency with other codes.

Updated READMEs.

There are still bugs which I'll fix soon!
More to come!
tp.data.save.cumkappa can now be written to csv for all you
machines out there.
tp plot avg-rates can now accept two files for silky smooth graphs
without excessive memory usage during AMSET.
The ability to add a DoS on the side of a phonon plot at the
command-line has be reintroduced.
finished new cli, deleted old one
added four.square_legend templates
improved docs
updated test
removed printing of data files with cumkappa plots (you can do that
separately easily now)
bug fixes
option for verbose output to say under which conditions (temperature
etc.) a plot is plotted. This is on by default at the command line and
off in the python interface.

bug fixes and performance improvements
new heatmap function add_pfmap, for power factor
new heatmap fuctions add_ztdiff and add_pfdiff, for the difference
between two zts or power factors
new axes.legend function alphabetise, for labelling axes (can enumerate
too)
default maximum value for the uniform colourmap is lighter
bug fixes
@kbspooner kbspooner merged commit 1aea199 into develop Mar 29, 2022
@kbspooner kbspooner deleted the simplify-axes branch April 7, 2022 08:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants