Skip to main content

spin_phonon_suite

spin_phonon_suite is a package for performing spin-phonon coupling calculations with openMOLCAS and Gaussian

Installation via pip

Install spin_phonon_suite using pip (if using a shared machine, add the --user argument after install)

pip install spin_phonon_suite

Updating

Update the code using pip (if using a shared machine, add the --user argument after install)

pip install spin_phonon_suite --upgrade

Installation with pip editable install

Only do this if you are developing (i.e. changing) the code.

Clone a copy of this repository, preferably while within a directory called git

mkdir -p git; cd git
git clone https://gitlab.com/chilton-group/spin_phonon_suite

Navigate to the package directory

cd spin_phonon_suite/packages

and install the package in editable mode (if using a shared machine, add the --user argument after install)

pip install -e .

When you're done developing (i.e. your changes have been merged to the master), or if you just want to use the current release version of the package, uninstall using pip

pip uninstall spin_phonon_suite

and follow the Installation via pip instructions above.

Usage

The spin_phonon_suite command line interface can be invoked with

spin_phonon_suite -h

which prints a list of available subprograms.

Alternatively, the individual submodules can be imported into a python program or script as per usual.

Building a .whl file (Advanced)

Only do this if you are told to.

To build a copy of the spin_phonon_suite .whl file, move to the package directory.

Now run

./build_binaries.sh

Then install the .whl file with pip (if using a shared machine, add the --user argument after install)

pip install dist/*.whl

Documentation

The documentation for this package is hosted by gitlab, and is automatically generated whenever new code is committed to the main branch. The automatic generation of this documentation relies on a common layout for comments and docstrings within the code, see contributing for more information.

Development

Before making changes to this repository, please follow the steps outlined in the Chilton group wiki.

Bugs

If you believe you have a bug, please check that you are using the most up to date version of the code.

If that does not fix the problem, please create an issue on GitLab detailing the following:

  • The commands you entered
  • The error message

Remember to simplify the problem as much as possible in order to provide a minimum working example, e.g. an example for a small molecule rather than one with 100000 atoms.

Then, look at the code, try and figure out what you think is wrong if possible, and include this in your issue.

Metadata

Release files for spin-phonon-suite 1.22.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 spin-phonon-suite 1.22.0
File Size Uploaded Provenance Actions
spin_phonon_suite-1.22.0.tar.gz 71.6 kB Without provenance Details for spin_phonon_suite-1.22.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for spin-phonon-suite 1.22.0
File Interpreter ABI Platform Actions
spin_phonon_suite-1.22.0-py3-none-any.whl Python 3 none any Details for spin_phonon_suite-1.22.0-py3-none-any.whl

Total release size: 144.7 kB

Release files / spin_phonon_suite-1.22.0.tar.gz

Download URL spin_phonon_suite-1.22.0.tar.gz
Size 71.6 kB
Tags Source
SHA-256 checksum
How to use checksums
f5f42b83c2bcb16dbf9fcc62470b7b99d9adb2a38d76bbfa6d01ee7a4d4d600f
BLAKE2b-256 checksum
How to use checksums
b0589f97889f8db73269c31b6a3c91715f0b8e79f039b30cea638255e5f38fba
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.25

Release files / spin_phonon_suite-1.22.0-py3-none-any.whl

Download URL spin_phonon_suite-1.22.0-py3-none-any.whl
Size 73.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3515cb86299a18c2fadc976329c1313adfc4b4d5bd6089ed7215a37caabf138f
BLAKE2b-256 checksum
How to use checksums
63a81c81d41d4c12b9d96691eb25754eb277da7c528051c56db740335bf1defe
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.25

Security for spin-phonon-suite 1.22.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

1.22.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