pySettle


NamepySettle JSON
Version 1.3.0 PyPI version JSON
download
home_page
SummaryComputes ignition conditions for Type I X-ray bursts using a multi-zone model of the Neutron star accreting layer
upload_time2023-11-10 09:52:14
maintainer
docs_urlNone
authorAndrew Cumming
requires_python>=3.6
licenseMIT
keywords settle
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ========
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), via a one-zone ignition criterion. For
more details, see
`Cumming & Bildsten (2000) <https://iopscience.iop.org/article/10.1086/317191>`_.

The code contains updates and improvements as described in `Goodwin et al.
(2019) <https://academic.oup.com/mnras/article/490/2/2228/5572467>`_
and subsequent work since.

Credits
-------

The original code was written by Andrew Cumming, with subsequent
modifications and updates by Adelle J. Goodwin, Martin Cupak, & Duncan K.
Galloway

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>`_.


            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "pySettle",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "",
    "keywords": "settle",
    "author": "Andrew Cumming",
    "author_email": "andrew.cumming@mcgill.ca",
    "download_url": "https://files.pythonhosted.org/packages/ad/82/533d9cf44885b2105ad06827bbd9704f8a4b606ff31bbe4cafa661a3605b/pySettle-1.3.0.tar.gz",
    "platform": null,
    "description": "========\npySettle\n========\n\nSettling solver - the BEANSp edition\n-----------------------------------------------------------------\n\n* Forked from settle project by Andrew Cumming\n  https://github.com/andrewcumming/settle\n* pySettle Repo: https://github.com/adellej/pysettle\n* BEANSp Repo: https://github.com/adellej/beans (related, using and depends on pySettle)\n\nFeatures\n--------\n\nThis code computes ignition conditions for Type I X-ray bursts using a\nmulti-zone model of the accreting layer (including hot CNO hydrogen\nburning, but not helium burning), via a one-zone ignition criterion. For\nmore details, see\n`Cumming & Bildsten (2000) <https://iopscience.iop.org/article/10.1086/317191>`_.\n\nThe code contains updates and improvements as described in `Goodwin et al.\n(2019) <https://academic.oup.com/mnras/article/490/2/2228/5572467>`_\nand subsequent work since.\n\nCredits\n-------\n\nThe original code was written by Andrew Cumming, with subsequent\nmodifications and updates by Adelle J. Goodwin, Martin Cupak, & Duncan K.\nGalloway\n\nPackage installation and usage\n------------------------------\npySettle is on pyPI (https://pypi.org/project/pySettle/) so installation is easy - either straight or in virtual environment:\n\n   .. code-block::\n   \n      pip install pySettle\n  \n   .. ::\n   \n   .. code-block::\n   \n      from pySettle import settler\n\n(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.)\n\nBuild and installation from this github repository\n--------------------------------------------------\n\nPlease refer to `build instructions <https://github.com/adellej/pysettle/blob/master/BUILD.rst>`_.\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Computes ignition conditions for Type I X-ray bursts                 using a multi-zone model of the Neutron star accreting layer",
    "version": "1.3.0",
    "project_urls": null,
    "split_keywords": [
        "settle"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2cb6914c1a8fddc6696a061455776376bf497e5d204f1d555e993ca249ab2d48",
                "md5": "6e015b25e82a46333c355a42f32f45d4",
                "sha256": "7240b12989e599c765fb3aadf00c240c5cad98fa492c2c798147370bd10a2dfa"
            },
            "downloads": -1,
            "filename": "pySettle-1.3.0-cp38-cp38-macosx_11_0_arm64.whl",
            "has_sig": false,
            "md5_digest": "6e015b25e82a46333c355a42f32f45d4",
            "packagetype": "bdist_wheel",
            "python_version": "cp38",
            "requires_python": ">=3.6",
            "size": 48396,
            "upload_time": "2023-11-10T09:52:13",
            "upload_time_iso_8601": "2023-11-10T09:52:13.328684Z",
            "url": "https://files.pythonhosted.org/packages/2c/b6/914c1a8fddc6696a061455776376bf497e5d204f1d555e993ca249ab2d48/pySettle-1.3.0-cp38-cp38-macosx_11_0_arm64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ad82533d9cf44885b2105ad06827bbd9704f8a4b606ff31bbe4cafa661a3605b",
                "md5": "86f5635f145e0f852fbfc3888cedd5ab",
                "sha256": "d018b9eee84bf01e5a2add21c12e2f0e7f2b084db104c7ef5e3e96fc9404993f"
            },
            "downloads": -1,
            "filename": "pySettle-1.3.0.tar.gz",
            "has_sig": false,
            "md5_digest": "86f5635f145e0f852fbfc3888cedd5ab",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 39805,
            "upload_time": "2023-11-10T09:52:14",
            "upload_time_iso_8601": "2023-11-10T09:52:14.785837Z",
            "url": "https://files.pythonhosted.org/packages/ad/82/533d9cf44885b2105ad06827bbd9704f8a4b606ff31bbe4cafa661a3605b/pySettle-1.3.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-11-10 09:52:14",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "pysettle"
}
        
Elapsed time: 0.13883s