Skip to main content

Tau2

Tau2 is a python package for simulating magnetic relaxation.

Installation via pip

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

pip install tau2

Updating

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

pip install tau2 --upgrade

Usage

The tau2 command line interface can be invoked with

tau2 -h

which prints a list of available subprograms.

Additional options for the raman and orbach programs can be viewed with --advanced_help.

Citation

If you've used Tau2 in your work, please cite the Tau2 paper: Atkinson, B. E. & Chilton, N. F. Tau2: A program for the simulation of magnetic relaxation. J. Chem. Theory Comput. https://doi.org/10.1021/acs.jctc.6c00890 (2026)

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.

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/tau2

Navigate to the package directory

cd tau2/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 tau2

and follow the Installation via pip instructions above.

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 tau2 4.0.1

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

Source distribution (sdist)

Source distribution for tau2 4.0.1
File Size Uploaded Provenance Actions
tau2-4.0.1.tar.gz 116.5 kB Without provenance Details for tau2-4.0.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for tau2 4.0.1
File Interpreter ABI Platform Actions
tau2-4.0.1-py3-none-any.whl Python 3 none any Details for tau2-4.0.1-py3-none-any.whl

Total release size: 220.2 kB

Release files / tau2-4.0.1.tar.gz

Download URL tau2-4.0.1.tar.gz
Size 116.5 kB
Tags Source
SHA-256 checksum
How to use checksums
6206ce87a660b3103f01a4a68e0ab26176622dfbd96f7120b54bf924fa514a03
BLAKE2b-256 checksum
How to use checksums
66b5d00fe3dd2469570bfdb2044ba144492635dce0a749b47bcf887b00547a00
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.15.2

Release files / tau2-4.0.1-py3-none-any.whl

Download URL tau2-4.0.1-py3-none-any.whl
Size 103.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6b830a57185f71f518c9568677f5e9ddb85066b453a041f3867d62394028620d
BLAKE2b-256 checksum
How to use checksums
5e8ca45667295c1c7b0bf0dd3524fd239f023510892c67a0f0cbbf05404140f9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.15.2

Security for tau2 4.0.1

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.

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