Metadata-Version: 2.1
Name: coilpy
Version: 0.3.24
Summary: Plotting and data processing tools for plasma and coil
Home-page: https://github.com/zhucaoxiang/CoilPy
Author: Caoxiang Zhu
Author-email: caoxiangzhu@gmail.com
License: GNU 3.0
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering
Description-Content-Type: text/markdown
License-File: LICENSE

CoilPy
======

This is Caoxiang Zhu's personal Python package for plotting and data processing.
Documentation can be found at https://zhucaoxiang.github.io/CoilPy/

Install
=======

You can install the package using `pip`.

```
pip install coilpy
```

Or from the GitHub

```
pip install git+https://github.com/zhucaoxiang/CoilPy
```

You can also install it after cloning the source code (this is useful if you have errors using `pip`).
```
pip install -e .
```
or
```
python setup.py install
```

Use
=======

After installation, in your python kernel, you can use the functions by something like
```python
from coilpy import *
```

You can always check the docstring of each functions, like `FourSurf?` in ipython.

Contact
=======

You can report bugs on `GitHub issues` and propose improvements using `pull request`.
For more information, please contact Dr. Caoxiang ZHU (caoxiangzhu[at]gmail.com).

