Skip to main content

DFT-Clustering

This program takes the output of DFT calculations carried out in the the computational platform StoBe for the simulation of NEXAFS to generate an optical tensor model derived from first principles. The result is a set of peaks that make up an optical model using a tensor based formalism that can be used to carry out simultaneous fits on angle resolved NEXAFS for the extraction of the molecular tilt angle. These peaks can then be used to obtain optical constants that could be subsequently used in the analysis of Resonant Soft X-Ray Scattering (R-SoXS) and Resonant X-Ray Reflectivity (XRR).

Build Requirements

The python helper functions used to require a STOBE to be installed in a particular method. This has been changed. Now the python helpers look for the following environment variable.

STOBE='\path\to\stobe\root\`

And they require the followign binaries to be in a bin accessable by the current user.

StoBe.x
xrayspec.x

These must be set, or StoBe will fail to instantiate the calculator.

Install Instructions

On Windows, download the latest release from the releases tab. Unzip the file and run the installer. The installer will install the necessary files in the appropriate directories.

Algorithm Specifications

The algorithm works by defining the following parameters:

  1. An energy cutoff that defines what is the maximum DFT transition energy to consider
  2. An oscillator strength threshold that filters transitions that do not have a sufficiently high intensity from subsequent steps
  3. A peak overlap threshold that determines whether two transitions can be clustered together depending on the overlap area between them.

These peak overlaps can then be subsequently used to generate a more compact set of peaks (i.e. transition clusters) that are representative of all the transitions initially calculated by the TP-DFT. The transition clusters are then combined with angle-resolved NEXAFS measurements in order to generate a quantitatively accurate optical model derived from first principle calculations.

Finally, the transition clusters that comprise the optical model can be used to identify the chemical, energetic and orientational character of the various NEXAFS features in addition to allow these NEXAFS features to be associated with specific MOs calculated from the TP-DFT.

The code runs on IGOR 8, however a Python implementation may be developed in the future. Also, the code takes StoBe output files as input, however, as long as the computational platform provides transition energies, transition intensities and the components of the transition dipole moment, then the loading function can be modified to accomodate other platforms.

The accompanying python files are there to:

  1. Facilitate the procedural generation of the .run files for a Transition Potential calculation carried out in StoBe
  2. Extract the Mulliken Population Analysis from the StoBe output files that can be subsequently loaded into IGOR to aid in the chemical characterization of NEXAFS transitions.

Setup Help

Setup

  1. Navigate to the following directory: Documents > Wavemetrics > Igor Pro 8 User Files
  2. Place the file clusteringPanel v1.ipf in the folder named "Igor Procedures"
  3. Navigate to the folder Documents > Wavemetrics > Igor Pro 8 User Files > User Procedures
  4. Place the contents of the folder "DFT_Clustering" inside the "User Procedures" directory
  5. Open an IGOR instance. There should be a tab titled Macros there. Within the dropdown menu in Macros there should be an option titled "Clustering Algorithm" which will load in the control panel for the algorithm.

Bug reporting/Help

For any concerns email me at victor.murcia@wsu.edu

Metadata

Release files for dft-learn 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for dft-learn 0.1.0
File Size Uploaded Provenance Actions
dft_learn-0.1.0.tar.gz 17.2 kB Without provenance Details for dft_learn-0.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for dft-learn 0.1.0
File Interpreter ABI Platform Actions
dft_learn-0.1.0-py3-none-any.whl Python 3 none any Details for dft_learn-0.1.0-py3-none-any.whl

Total release size: 34.3 kB

Release files / dft_learn-0.1.0.tar.gz

Download URL dft_learn-0.1.0.tar.gz
Size 17.2 kB
Tags Source
SHA-256 checksum
How to use checksums
edcaf9712c4e42715f5e0a985ecd60e490154d853706b8cbab057f06ee81649a
BLAKE2b-256 checksum
How to use checksums
fdb6b71119d33533dcad764a4e38d3ccc9ce10a83cbc05722d1a765eacf68a49
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.8.13

Release files / dft_learn-0.1.0-py3-none-any.whl

Download URL dft_learn-0.1.0-py3-none-any.whl
Size 17.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
dadf0da323641fbca4faa90d4ae9589e0786c2696bbb8bad8814161b040d38a2
BLAKE2b-256 checksum
How to use checksums
7748693b5b94e6a1d6b5fb75f51a9676a48dba07b7e6a9cc9bc817816890722d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.8.13

Security for dft-learn 0.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page