Skip to content

Conversation

@naik-aakash
Copy link
Collaborator

@naik-aakash naik-aakash commented Sep 10, 2024

Closes #329

Changes

  • Add ultiliy functions to compute reduced masses, electronegativity and sort dict by values
  • Add the possibility to modify default lobsterpy kwargs in featurizers
  • Add ICOXX featurizer with BWDF functionality
  • Get BWDF statistical features
  • Investigate incosistencies in translation vectors wrt bond distances in ICOXXLIST.lobster (result :-> only inconsistent if POSCAR is read, it is consistent when CONTCAR/POSCAR.lobster/POSCAR.lobster.vasp is read)
  • Make CONTCAR as default file to read in automatic analysis and featurizers (translations are then consistent with lobster files)
  • Add tests

@naik-aakash naik-aakash marked this pull request as draft September 10, 2024 15:44
@naik-aakash naik-aakash self-assigned this Sep 10, 2024
@naik-aakash naik-aakash added the enhancement New feature or request label Sep 10, 2024
@naik-aakash
Copy link
Collaborator Author

Hi @JaGeo, there seems to be some issue with coverage artificats not being generated and uploaded in CI, I have not been able to pinpoint the cause yet. Will check again in detail tomorrow. Leaving this as a comment only for my reference here.

@naik-aakash
Copy link
Collaborator Author

Could be simply bug associated with a new release of pytest today. Will have to check downgrading it

@JaGeo
Copy link
Owner

JaGeo commented Sep 10, 2024

@naik-aakash sure. Don't worry!

@naik-aakash
Copy link
Collaborator Author

@naik-aakash sure. Don't worry!

issue was with upload artificats update ignoring hidden files from being uploaded. It should be fixed now in PR #331

@naik-aakash naik-aakash marked this pull request as ready for review September 16, 2024 12:39
@naik-aakash naik-aakash changed the title [WIP] add new functions/methods to featurize module Add new functions/methods to featurize module Sep 16, 2024
@naik-aakash naik-aakash requested a review from JaGeo September 16, 2024 12:40
@naik-aakash naik-aakash marked this pull request as draft September 17, 2024 09:08
@naik-aakash
Copy link
Collaborator Author

Hi @JaGeo , I think this PR could be merged now

@naik-aakash naik-aakash marked this pull request as ready for review December 17, 2024 06:38
Copy link
Contributor

@kaueltzen kaueltzen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe a warning if POSCAR is parsed anywhere would be the most elegant way?

help='path to structure file. Default is "POSCAR". '
help='path to structure file. Default is "CONTCAR". '
'Can also read "POSCAR.lobster" file or any '
'suitable file format supported by pymatgen "Structure.from_file" method.',
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would add a warning in the doc here that translations might be inconsistent with LOBSTER if POSCAR or other structure formats derived from POSCAR are used. And / or a warning is raised if POSCAR is parsed.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good

help=(
"Deliver a text description of the LOBSTER calc quality analysis. "
"Mandatory required files: POSCAR, POTCAR, lobsterout, lobsterin. "
"Mandatory required files: CONTCAR, POTCAR, lobsterout, lobsterin. "
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would change it to "CONTCAR or other structure file compatible with --file-structure"

:return: path to structure file
"""
for filename in ["POSCAR", "POSCAR.lobster", "POSCAR.lobster.vasp"]:
for filename in ["CONTCAR", "POSCAR.lobster", "POSCAR.lobster.vasp"]:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add "POSCAR" as last option?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense, yes


With LobsterPy, these intricate details are handled with a single command. We need the standard VASP input files, i.e.
``INCAR, KPOINTS, POTCAR and POSCAR`` in the calculation directory. Once you have these files, one needs to run the following command:
``INCAR, KPOINTS, POTCAR and CONTCAR`` in the calculation directory. Once you have these files, one needs to run the following command:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This needs to be adapted in the other .rst files as well, e.g. descriptionquality.rst

… POSCAR to list of possible files in structure path of featurize
auto-merge was automatically disabled December 19, 2024 13:41

Head branch was pushed to by a user without write access

@naik-aakash naik-aakash requested a review from JaGeo December 20, 2024 10:09
@naik-aakash naik-aakash merged commit 36da300 into JaGeo:main Dec 20, 2024
22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update featurizer module with more options

4 participants