angmom_suite
angmom_suite is a python package for working with phenomenological spin and angular momentum operators
Installation via pip
Install angmom_suite using pip (if using a shared machine, add the --user argument after install)
pip install angmom_suite
Updating
Update the code using pip (if using a shared machine, add the --user argument after install)
pip install angmom_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/angmom_suite
Navigate to the package directory
cd angmom_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 angmom_suite
and follow the Installation via pip instructions above.
Usage
The angmom_suite command line interface can be invoked with
angmom_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 angmom_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.
4 maintainers
Release files for angmom-suite 1.33.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| angmom_suite-1.33.0.tar.gz | 76.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| angmom_suite-1.33.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 155.4 kB
Release files / angmom_suite-1.33.0.tar.gz
| Download URL | angmom_suite-1.33.0.tar.gz |
|---|---|
| Size | 76.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f615eccaeefc39bf717e0a1806b3b0adbdc8eaa5f19558b881e2a2e3bfcc2c5b
|
|
BLAKE2b-256 checksum How to use checksums |
69a3f184f282fc741adaccb3672c1b11169594f7f9e98de3d3d26b698d0869fe
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
Release files / angmom_suite-1.33.0-py3-none-any.whl
| Download URL | angmom_suite-1.33.0-py3-none-any.whl |
|---|---|
| Size | 78.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
88ac4c03589ccab2a08d3006755ac3a23c5d03d80173f4c6f38b041d0a65a73b
|
|
BLAKE2b-256 checksum How to use checksums |
020acc7ab843af11032913688f7ecebdfc310f132dcfd27abff1500e2598ac19
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
