Skip to main content

A wrapper around Pickett's SPFIT and SPCAT

Project description

Pyckett

Pyckett is a python wrapper around the SPFIT/SPCAT package (H. M. Pickett, "The Fitting and Prediction of Vibration-Rotation Spectra with Spin Interactions," J. Mol. Spectrosc. 148, 371-377 (1991)).

Install the package with pip by using the following command

pip install pyckett

If SPFIT and SPCAT cannot be executed via the commands spfit and spcat (if they are not in your PATH or have different names) point to them by setting the PYCKETT_SPFIT_PATH and PYCKETT_SPCAT_PATH environment variables to their full paths.

If you want to acknowledge LLWP, please cite the paper On the Spectroscopy of Phosphaalkynes: Millimeter- and Submillimeter-Wave Study of C2H5CP.

Documentation

Currently, the documentation is limited to the docstrings of the main library. To easily access the docstrings you can run

pip install pdoc
pdoc pyckett

after having installed Pyckett.

The CLI tools provide help texts via the -h or --help flags.

CLI Tools

Pyckett provides a set of command line utilities which perform common steps of an iterative fitting process.

pyckett_add helps adding new parameters to the fit, pyckett_omit is used for evaluating which parameters can be omitted.

pyckett_separatefits can be used to separate a global fit into separate fits for each state.

pyckett_uncertainties evaluates the uncertainties of the parameters.

pyckett_partitionfunction calculates the partition function for different temperatures.

pyckett_auto automatically builds up the Hamiltonian step by step.

pyckett_fit and pyckett_cat are shortcuts to SPFIT and SPCAT, respectively.

pyckett_pmix quickly prints the mixing coefficients of an *.egy file to identify interaction regions.

See the respective help functions (by adding --help after the command) to see their syntax.

Examples

You can read files from the SPFIT/SPCAT universe with the following syntax

var_dict = pyckett.parvar_to_dict(r"path/to/your/project/molecule.var")
par_dict = pyckett.parvar_to_dict(r"path/to/your/project/molecule.par")
int_dict = pyckett.int_to_dict(r"path/to/your/project/molecule.int")
lin_df = pyckett.lin_to_df(r"path/to/your/project/molecule.lin")
cat_df = pyckett.cat_to_df(r"path/to/your/project/molecule.cat")
egy_df = pyckett.egy_to_df(r"path/to/your/project/molecule.egy")

erham_df = pyckett.erhamlines_to_df(r"path/to/your/project/molecule.in")

Finalize cat file

This function merges the cat and lin dataframes, sums up duplicate values in the cat file and allows to translate quantum numbers:

fin_cat_df, fin_lin_df = pyckett.finalize(cat_df, lin_df, qn_tdict, qn)

Find candidates for double-resonance measurements

This function finds possible transition arrangements for double-resonance measurements. Input two cat dataframes with the transitions that are in the range of your probe and pump source.

results_df = pyckett.get_dr_candidates(cat_df1, cat_df2)

Check Crossings

pyckett.check_crossings(egy_df, [1], range(10))

Plot Mixing Coefficients

pyckett.mixing_coefficient(egy_df, "qn4 == 1 and qn2 < 20 and qn1 < 20 and qn1==qn2+qn3")

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyckett-0.1.22.tar.gz (29.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyckett-0.1.22-py3-none-any.whl (31.4 kB view details)

Uploaded Python 3

File details

Details for the file pyckett-0.1.22.tar.gz.

File metadata

  • Download URL: pyckett-0.1.22.tar.gz
  • Upload date:
  • Size: 29.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.13.0

File hashes

Hashes for pyckett-0.1.22.tar.gz
Algorithm Hash digest
SHA256 4aacb6b6f29aa8af9a5379e1f8239c724f61adfe91b084236062821308af8e17
MD5 dc831425a23ba90da50141af5f068fc8
BLAKE2b-256 775c9affc6b04c7a268ee48f663c002da9f5c2cf56ed4fda690045dce058ee69

See more details on using hashes here.

File details

Details for the file pyckett-0.1.22-py3-none-any.whl.

File metadata

  • Download URL: pyckett-0.1.22-py3-none-any.whl
  • Upload date:
  • Size: 31.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.13.0

File hashes

Hashes for pyckett-0.1.22-py3-none-any.whl
Algorithm Hash digest
SHA256 d6e42d219a39c297a1c8db5e236d54634e826ebcea53476b84a75de4e2cfcd16
MD5 4f2e206250c8584651f71857143abb80
BLAKE2b-256 78fd82356dcd593c708e23be40e6bbbf67c0d1aee3ac106f9fe792cfe1bfe4ee

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page