Metadata-Version: 2.4
Name: spinguin
Version: 0.0.3
Summary: Spinguin is an intuitive Python package for versatile numerical spin-dynamics simulations.
Author-email: Joni Eronen <joni.eronen@oulu.fi>, Perttu Hilla <perttu.hilla@oulu.fi>
License: MIT License
        
        Copyright (c) [2025] [Joni Eronen]
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=1.26.4
Requires-Dist: scipy>=1.14.1
Requires-Dist: sympy>=1.13.1
Requires-Dist: joblib>=1.5.1
Dynamic: license-file

# Spinguin

## Description
Spinguin is a user-friendly Python package designed for versatile numerical
spin-dynamics simulations in liquid state. It offers tools for performing
simulations using restricted basis sets, enabling the use of large spin systems
with more than 10 spins on consumer-level hardware. Spinguin supports the
simulation of coherent dynamics, relaxation, and chemical exchange processes.

## Documentation
Documentation for the package is available here:
https://nmroulu.github.io/Spinguin/

## Installation
Spinguin can be installed in various ways, depending on your needs and
preferences. You can install it from the Python Package Index (PyPI) or build it
from the source code available on GitHub. Below are the instructions for both
methods.

### Installation from PyPI
Spinguin is available from the Python Package Index (PyPI) repository for
Windows and Linux. To install the package, simply issue the command::

```bash
pip install spinguin
```

### Installation from source
1. Ensure the `build` module is installed:
    ```bash
    pip install build
    ```
2. Download the source code archive (.zip or .tar.gz).
3. Extract the archive (e.g., using 7-Zip).
4. Navigate to the extracted folder:
    ```bash
    cd /your/path/spinguin-X.Y.Z
    ```
5. Build the wheel from the source:
    ```bash
    python -m build --wheel
    ```
6. Navigate to the `dist` folder:
    ```bash
    cd /your/path/spinguin-X.Y.Z/dist
    ```
7. Install the wheel using pip:
    ```bash
    pip install spinguin-X.Y.Z-cpXYZ-cpXYZ-PLATFORM.whl
    ```

## License
This project is licensed under the [MIT License](LICENSE).
