Metadata-Version: 2.4
Name: torc
Version: 0.2.0
Summary: Magnetic coil field and gradient calculations and display
Author-email: Christopher Billington <chrisjbillington@gmail.com>
License-Expression: BSD-2-Clause
Project-URL: Homepage, https://github.com/chrisjbillington/torc
Project-URL: Documentation, https://github.com/chrisjbillington/torc
Project-URL: Repository, https://github.com/chrisjbillington/torc
Project-URL: Downloads, https://pypi.org/project/torc/
Project-URL: Tracker, https://github.com/chrisjbillington/torc/issues
Keywords: magnetic fields,magnetic coils,magneto-optical trap,atomic physics
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: setuptools_scm
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: matplotlib
Requires-Dist: pyqtgraph
Requires-Dist: PySide6
Requires-Dist: pyopengl
Dynamic: license-file

# torc

Torc is a Python library for computing magnetic fields resulting from magnetic coils
such as loops, lines, round coils and racetrack coils of rectangular cross section,
positioned and oriented arbitrarily in space.

Documentation and examples yet to come, but there is one example, `example.py`, that you
can run:

```bash
python example.py
```

This displays an arrangement of coils that represents the magnetic transport assembly
for the cold atom experiment in the RbChip lab in the Spielman group at NIST:

![rb_chip_coils.png](rb_chip_coils.png)

## Requirements

Requires `numpy` and `scipy`, and `pyqtgraph`.


## Installation

From pip: `pip install torc`
From source: Clone this repository and tun `python setup.py install`
