ampyl

KO | EN

gitlite — search

#hacktoberfest #llm #golang #android #docker #macos #windows #awesome #kubernetes #vue #awesome-list #pytorch #mcp #open-source

(★ 9)

Python package for relating finite-volume data to amplitudes

ampyl Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![Build/Test](https://github.com/mthansen/ampyl/workflows/Build/Test/badge.svg)](https://github.com/mthansen/ampyl/actions?query=workflow%3ABuild%2FTest)
![Docs](https://github.com/mthansen/ampyl/workflows/Docs/badge.svg)
[![codecov](https://codecov.io/gh/mthansen/ampyl/branch/main/graph/badge.svg?token=IR43OJAV6T)](https://codecov.io/gh/mthansen/ampyl)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

A Python package to relate finite-volume data to amplitudes.

The name AmPyL ("am-pie-ell") stands for **Am**plitdues via **Py**thon from finite-volume (**L**) data. The package requires python version 3.9.x or newer.

- **Website:** https://github.com/mthansen/ampyl
- **Documentation:** https://mthansen.github.io/ampyl/
- **Examples:** [examples](./examples)
- **Bug reports:** https://github.com/mthansen/ampyl/issues

### Authors

## Installation

The NumPy package is required to use AmPyL. The latest version AmPyL can be installed locally, e.g. using `pip`:

```python
git clone https://github.com/mthansen/ampyl
cd ampyl
pip install .

python
import numpy
import ampyl
```

## Documentation

The documentation is generated from the package and docstrings with
pdoc. To build it locally, install the documentation dependencies and run:

```bash
pip install -e ".[docs]"
make -C doc html
```

The generated site is written to `doc/_build/html/index.html`. The same pdoc
build runs on GitHub Actions for pull requests and publishes from `main` with
GitHub Pages.

## Example

```python
import ampyl
from ampyl.flavor import FlavorChannel
from ampyl.flavor import FlavorChannelSpace
from ampyl.spaces import QCIndexSpace
from scipy.optimize import root_scalar

# single 3-particle channel
fc = FlavorChannel(3)
fcs = FlavorChannelSpace(fc_list=[fc])
qcis = QCIndexSpace(fcs=fcs,
                    Emax=5.0, Lmax=6.0)
qcis.populate()
qc = ampyl.QC(qcis=qcis)
k_params = qcis.default_k_params()
# k_params default is [[[0.0]], [0.0]]
# first entry is the scattering length
# second entry is kdf (3-body
# interaction):
L = 5.
k_params[0][0][0] = 0.1  # scattering length
qc_dict = {'k_params': k_params,
           'project': True,
           'irrep': ('A1PLUS', 0)}
args = (L, qc_dict)
bracket = [3.001, 3.1]
print(root_scalar(qc.get_value, args=args,
                  bracket=bracket).root
     )
# Returns ground state energy
# around 3.031816
```

ampyl

ampyl Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

ampyl

ampyl Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README