Metadata-Version: 2.4
Name: pnspy
Version: 0.2.1
Summary: A lightweight package for principal nested spheres (PNS) analysis
Author-email: Jisoo Song <jeesoo9595@snu.ac.kr>
License-Expression: MIT
Project-URL: homepage, https://pypi.python.org/pypi/pnspy/
Project-URL: source, https://github.com/JSS95/pnspy
Project-URL: documentation, https://pnspy.readthedocs.io
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Scientific/Engineering
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: scipy
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Provides-Extra: doc
Requires-Dist: sphinx; extra == "doc"
Requires-Dist: numpydoc; extra == "doc"
Requires-Dist: pydata_sphinx_theme; extra == "doc"
Requires-Dist: matplotlib; extra == "doc"
Provides-Extra: dev
Requires-Dist: flake8; extra == "dev"
Requires-Dist: black; extra == "dev"
Requires-Dist: isort; extra == "dev"
Requires-Dist: pnspy[doc,test]; extra == "dev"
Dynamic: license-file

# PnsPy

[![Supported Python Versions](https://img.shields.io/pypi/pyversions/pnspy.svg)](https://pypi.python.org/pypi/pnspy/)
[![PyPI Version](https://img.shields.io/pypi/v/pnspy.svg)](https://pypi.python.org/pypi/pnspy/)
[![License](https://img.shields.io/github/license/JSS95/pnspy)](https://github.com/JSS95/pnspy/blob/master/LICENSE)
[![CI](https://github.com/JSS95/pnspy/actions/workflows/ci.yml/badge.svg)](https://github.com/JSS95/pnspy/actions/workflows/ci.yml)
[![CD](https://github.com/JSS95/pnspy/actions/workflows/cd.yml/badge.svg)](https://github.com/JSS95/pnspy/actions/workflows/cd.yml)
[![Docs](https://readthedocs.org/projects/pnspy/badge/?version=latest)](https://pnspy.readthedocs.io/en/latest/?badge=latest)

PnsPy is a lightweight Python package for principal nested spheres (PNS) analysis.

## Installation

```
$ pip install pnspy
```

## Documentation

The manual can be found online:

> https://pnspy.readthedocs.io

If you want to build the documentation yourself, get the source code and install with `[doc]` dependency.
Then, go to the `doc` directory and build the documentation:

```
$ pip install .[doc]
$ cd doc
$ make html
```

The documentation will be generated in the `build/html` directory. Open `index.html` to see the main page.
