Metadata-Version: 2.1
Name: pySettle
Version: 1.0.0
Summary: Computes ignition conditions for Type I X-ray bursts                 using a multi-zone model of the Neutron star accreting layer
Author: Andrew Cumming
Author-email: andrew.cumming@mcgill.ca
License: MIT
Keywords: settle
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.6
License-File: LICENSE

========
pySettle
========

Settling solver - the BEANSp edition
-----------------------------------------------------------------

* Forked from settle project by Andrew Cumming
  https://github.com/andrewcumming/settle
* pySettle Repo: https://github.com/adellej/pysettle
* BEANSp Repo: https://github.com/adellej/beans (related, using and depends on pySettle)

Features
--------

This code computes ignition conditions for Type I X-ray bursts using a multi-zone model of the accreting layer (including hot CNO hydrogen burning, but not helium burning), but a one-zone ignition criterion. For more details, see Cumming & Bildsten (2000).

Credits
-------

Rotational Evolution During Type I X-Ray Bursts, Andrew Cumming, Lars Bildsten (2000) - https://arxiv.org/abs/astro-ph/0004347

Package installation and usage
------------------------------
pySettle is on pyPI (https://pypi.org/project/pySettle/) so installation is easy - either straight or in virtual environment:

   .. code-block::
   
      pip install pySettle
  
   .. ::
   
   .. code-block::
   
      from pySettle import settler

(See the code of test script `test_settle_sft.py <https://github.com/adellej/pysettle/blob/master/tests/test_settle_sft.py>`_ as an example.)

Build and installation from this github repository
--------------------------------------------------

Please refer to `build instructions <https://github.com/adellej/pysettle/blob/master/BUILD.rst>`_.

