Metadata-Version: 2.1
Name: cherab-phix
Version: 0.2.1
Summary: Cherab spectroscopy framework: PHiX machine configuration
Author-email: Koyo Munechika <munechika.koyo@torus.nr.titech.ac.jp>
Maintainer-email: Koyo Munechika <munechika.koyo@torus.nr.titech.ac.jp>
License: BSD 3-Clause License
        
        Copyright (c) 2019-2022, Koyo MUNECHIKA
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        3. Neither the name of the copyright holder nor the names of its
           contributors may be used to endorse or promote products derived from
           this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        
Project-URL: Homepage, https://cherab-phix.readthedocs.io/
Project-URL: documentation, https://cherab-phix.readthedocs.io/
Project-URL: repository, https://github.com/munechika-koyo/cherab_phix
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Cython
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: <3.10,>=3.8
Description-Content-Type: text/markdown
Provides-Extra: docs
Provides-Extra: dev
License-File: LICENSE.md
License-File: AUTHORS.md

# CHERAB-PHiX

![PyPI](https://img.shields.io/pypi/v/cherab-phix?logo=PyPI)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/cherab-phix?logo=Python)

[![DOI](https://zenodo.org/badge/239309930.svg)](https://zenodo.org/badge/latestdoi/239309930)
![GitHub](https://img.shields.io/github/license/munechika-koyo/cherab_phix)

[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/munechika-koyo/cherab_phix/master.svg)](https://results.pre-commit.ci/latest/github/munechika-koyo/cherab_phix/master)
[![Documentation Status](https://readthedocs.org/projects/cherab-phix/badge/?version=stable)](https://cherab-phix.readthedocs.io/en/stable/?badge=stable)

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
[![Docstring formatter: docformatter](https://img.shields.io/badge/%20formatter-docformatter-fedcba.svg)](https://github.com/PyCQA/docformatter)
[![Docstring style: numpy](https://img.shields.io/badge/%20style-numpy-459db9.svg)](https://numpydoc.readthedocs.io/en/latest/format.html)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)


CHERAB for PHiX, which is a small tokamak device in Tokyo Institute of Technology
For more information, see the [documentation pages](https://cherab-phix.readthedocs.io/).

Quick installation
-------------------
Install it from GitHub repository with pip:

```Shell
python -m pip install cherab-phix
```

For Developpers
---
If you would like to modificate codes, it is much easier to create a conda development environment after cloning repository.
```Shell
conda env create -f environment.yaml
conda activate cherab-phix-dev
python dev.py build
python dev.py install
```
And please follows the development [specified procedure](https://cherab-phix.readthedocs.io/en/development/user/contribution.html).

![The plasma discharged image captured by the high-speed camera](docs/_static/images/phix.jpg)

*Caption: The plasma discharged image captured by the high-speed camera at PHiX.*
