frank


Namefrank JSON
Version 1.2.2 PyPI version JSON
download
home_pagehttps://github.com/discsim/frank
SummaryFrankenstein, the flux reconstructor
upload_time2023-07-10 12:40:22
maintainer
docs_urlNone
authorRichard Booth, Jeff Jennings, Marco Tazzari
requires_python>=3.7
licenseLGPLv3
keywords science astronomy interferometry
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <p align="center">
   <img width = "800" src="https://github.com/discsim/frank/blob/master/docs/images/day_off.png?raw=true"/>		   
 </p>

<p align="center">
  <!-- current release -->
  <a href="https://github.com/discsim/frank/releases">
      <img src="https://img.shields.io/github/release/discsim/frank/all.svg">
  </a>

  <!-- current version on pypi -->
  <a href="https://pypi.python.org/pypi/frank">
      <img src="https://img.shields.io/pypi/v/frank.svg">

  <br/>
  <!-- changelog -->
  <a href="https://github.com/discsim/frank/blob/master/HISTORY.rst">
    <img src="https://img.shields.io/badge/changelog-detailed-blue"/>
  </a>

  <!-- zenodo -->
  <a href="https://doi.org/10.5281/zenodo.3832064">
      <img src="https://zenodo.org/badge/DOI/10.5281/zenodo.3832064.svg" alt="DOI">

  <br/>
  <!-- tests -->
  <a href="https://github.com/discsim/frank/actions/workflows/tests.yml">
      <img src="https://github.com/discsim/frank/actions/workflows/tests.yml/badge.svg">
  </a>    

  <!-- docs build -->
  <a href="https://github.com/discsim/frank/actions/workflows/docs.yml">
    <img src="https://github.com/discsim/frank/actions/workflows/docs.yml/badge.svg"/>
  </a>   

  <!-- coverage -->
  <a href="https://discsim.github.io/frank/coverage/index.html">
      <img src="https://discsim.github.io/frank/coverage/badge.svg">

  <br/>
  <!-- paper -->
  <a href="https://academic.oup.com/mnras/advance-article/doi/10.1093/mnras/staa1365/5838058?guestAccessKey=7f163a1f-c12f-4771-8e54-928636794a5b">
      <img src="https://img.shields.io/badge/paper-MNRAS-blue.svg">
  </a>

  <br/>
  <!-- license -->
  <a href="https://www.gnu.org/licenses/lgpl-3.0">
      <img src="https://img.shields.io/badge/license-LGPL%20v3-blue.svg">   
  </a>      
</p>

Frankenstein (**frank**) is a library that fits the 1D radial brightness profile of an interferometric source given a set of visibilities. It uses a Gaussian process that performs the fit in <1 minute for a typical protoplanetary disc continuum dataset.

Get the code
------------
```
pip install frank
```

Documentation
-------------
Check out the [docs](https://discsim.github.io/frank/).

Attribution
-----------
If you use **frank** for your research please cite Jennings, Booth, Tazzari et al. 2020 MNRAS 495(3) 3209
[[MNRAS]](https://academic.oup.com/mnras/article/495/3/3209/5838058?guestAccessKey=7f163a1f-c12f-4771-8e54-928636794a5b)
[[ADS]](https://ui.adsabs.harvard.edu/abs/2020MNRAS.495.3209J/abstract)
[[arXiv]](https://arxiv.org/abs/2005.07709)
[[Zenodo]](https://doi.org/10.5281/zenodo.3832064):
```
@ARTICLE{2020MNRAS.495.3209J,
       author = {{Jennings}, Jeff and {Booth}, Richard A. and {Tazzari}, Marco and {Rosotti}, Giovanni P. and {Clarke}, Cathie J.},
        title = "{frankenstein: protoplanetary disc brightness profile reconstruction at sub-beam resolution with a rapid Gaussian process}",
      journal = {\mnras},
     keywords = {methods: data analysis, protoplanetary discs, techniques: interferometric, planets and satellites: detection, submillimetre: general, submillimetre: planetary systems, Astrophysics - Earth and Planetary Astrophysics, Astrophysics - Instrumentation and Methods for Astrophysics},
         year = 2020,
        month = jul,
       volume = {495},
       number = {3},
        pages = {3209-3232},
          doi = {10.1093/mnras/staa1365},
archivePrefix = {arXiv},
       eprint = {2005.07709},
 primaryClass = {astro-ph.EP},
       adsurl = {https://ui.adsabs.harvard.edu/abs/2020MNRAS.495.3209J},
      adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}
```

[These papers](https://ui.adsabs.harvard.edu/search/q=citations(doi%3A10.1093%2Fmnras%2Fstaa1365)%20&sort=date%20desc%2C%20bibcode%20desc&p_=0) cite **frank**.

Authors
-------
- [Richard 'Dr. Frankenstein' Booth](https://github.com/rbooth200)

- [Jeff 'The Monster' Jennings](https://github.com/jeffjennings)

- [Marco 'It's Alive!!!' Tazzari](https://github.com/mtazzari)

### Contact ###
Submit a bug report or feature request on the [issues page](https://github.com/discsim/frank/issues). For anything else, feel free to [email Jeff](mailto:jjennings1519@gmail.com).

License
-------
**frank** is free software licensed under the LGPLv3 License. For more details see the [LICENSE](https://github.com/discsim/frank/blob/master/LICENSE.txt).

© Copyright 2019-2022 Richard Booth, Jeff Jennings, Marco Tazzari.

Image: Universal Studios, NBCUniversal [Public domain]

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/discsim/frank",
    "name": "frank",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "science,astronomy,interferometry",
    "author": "Richard Booth, Jeff Jennings, Marco Tazzari",
    "author_email": "jjennings1519@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/6f/82/868b39f290bd1f35775759b1d693f606c7982966fc7566a0404b4b85cc75/frank-1.2.2.tar.gz",
    "platform": null,
    "description": "<p align=\"center\">\n   <img width = \"800\" src=\"https://github.com/discsim/frank/blob/master/docs/images/day_off.png?raw=true\"/>\t\t   \n </p>\n\n<p align=\"center\">\n  <!-- current release -->\n  <a href=\"https://github.com/discsim/frank/releases\">\n      <img src=\"https://img.shields.io/github/release/discsim/frank/all.svg\">\n  </a>\n\n  <!-- current version on pypi -->\n  <a href=\"https://pypi.python.org/pypi/frank\">\n      <img src=\"https://img.shields.io/pypi/v/frank.svg\">\n\n  <br/>\n  <!-- changelog -->\n  <a href=\"https://github.com/discsim/frank/blob/master/HISTORY.rst\">\n    <img src=\"https://img.shields.io/badge/changelog-detailed-blue\"/>\n  </a>\n\n  <!-- zenodo -->\n  <a href=\"https://doi.org/10.5281/zenodo.3832064\">\n      <img src=\"https://zenodo.org/badge/DOI/10.5281/zenodo.3832064.svg\" alt=\"DOI\">\n\n  <br/>\n  <!-- tests -->\n  <a href=\"https://github.com/discsim/frank/actions/workflows/tests.yml\">\n      <img src=\"https://github.com/discsim/frank/actions/workflows/tests.yml/badge.svg\">\n  </a>    \n\n  <!-- docs build -->\n  <a href=\"https://github.com/discsim/frank/actions/workflows/docs.yml\">\n    <img src=\"https://github.com/discsim/frank/actions/workflows/docs.yml/badge.svg\"/>\n  </a>   \n\n  <!-- coverage -->\n  <a href=\"https://discsim.github.io/frank/coverage/index.html\">\n      <img src=\"https://discsim.github.io/frank/coverage/badge.svg\">\n\n  <br/>\n  <!-- paper -->\n  <a href=\"https://academic.oup.com/mnras/advance-article/doi/10.1093/mnras/staa1365/5838058?guestAccessKey=7f163a1f-c12f-4771-8e54-928636794a5b\">\n      <img src=\"https://img.shields.io/badge/paper-MNRAS-blue.svg\">\n  </a>\n\n  <br/>\n  <!-- license -->\n  <a href=\"https://www.gnu.org/licenses/lgpl-3.0\">\n      <img src=\"https://img.shields.io/badge/license-LGPL%20v3-blue.svg\">   \n  </a>      \n</p>\n\nFrankenstein (**frank**) is a library that fits the 1D radial brightness profile of an interferometric source given a set of visibilities. It uses a Gaussian process that performs the fit in <1 minute for a typical protoplanetary disc continuum dataset.\n\nGet the code\n------------\n```\npip install frank\n```\n\nDocumentation\n-------------\nCheck out the [docs](https://discsim.github.io/frank/).\n\nAttribution\n-----------\nIf you use **frank** for your research please cite Jennings, Booth, Tazzari et al. 2020 MNRAS 495(3) 3209\n[[MNRAS]](https://academic.oup.com/mnras/article/495/3/3209/5838058?guestAccessKey=7f163a1f-c12f-4771-8e54-928636794a5b)\n[[ADS]](https://ui.adsabs.harvard.edu/abs/2020MNRAS.495.3209J/abstract)\n[[arXiv]](https://arxiv.org/abs/2005.07709)\n[[Zenodo]](https://doi.org/10.5281/zenodo.3832064):\n```\n@ARTICLE{2020MNRAS.495.3209J,\n       author = {{Jennings}, Jeff and {Booth}, Richard A. and {Tazzari}, Marco and {Rosotti}, Giovanni P. and {Clarke}, Cathie J.},\n        title = \"{frankenstein: protoplanetary disc brightness profile reconstruction at sub-beam resolution with a rapid Gaussian process}\",\n      journal = {\\mnras},\n     keywords = {methods: data analysis, protoplanetary discs, techniques: interferometric, planets and satellites: detection, submillimetre: general, submillimetre: planetary systems, Astrophysics - Earth and Planetary Astrophysics, Astrophysics - Instrumentation and Methods for Astrophysics},\n         year = 2020,\n        month = jul,\n       volume = {495},\n       number = {3},\n        pages = {3209-3232},\n          doi = {10.1093/mnras/staa1365},\narchivePrefix = {arXiv},\n       eprint = {2005.07709},\n primaryClass = {astro-ph.EP},\n       adsurl = {https://ui.adsabs.harvard.edu/abs/2020MNRAS.495.3209J},\n      adsnote = {Provided by the SAO/NASA Astrophysics Data System}\n}\n```\n\n[These papers](https://ui.adsabs.harvard.edu/search/q=citations(doi%3A10.1093%2Fmnras%2Fstaa1365)%20&sort=date%20desc%2C%20bibcode%20desc&p_=0) cite **frank**.\n\nAuthors\n-------\n- [Richard 'Dr. Frankenstein' Booth](https://github.com/rbooth200)\n\n- [Jeff 'The Monster' Jennings](https://github.com/jeffjennings)\n\n- [Marco 'It's Alive!!!' Tazzari](https://github.com/mtazzari)\n\n### Contact ###\nSubmit a bug report or feature request on the [issues page](https://github.com/discsim/frank/issues). For anything else, feel free to [email Jeff](mailto:jjennings1519@gmail.com).\n\nLicense\n-------\n**frank** is free software licensed under the LGPLv3 License. For more details see the [LICENSE](https://github.com/discsim/frank/blob/master/LICENSE.txt).\n\n\u00a9 Copyright 2019-2022 Richard Booth, Jeff Jennings, Marco Tazzari.\n\nImage: Universal Studios, NBCUniversal [Public domain]\n",
    "bugtrack_url": null,
    "license": "LGPLv3",
    "summary": "Frankenstein, the flux reconstructor",
    "version": "1.2.2",
    "project_urls": {
        "Bug Tracker": "https://github.com/discsim/frank/issues",
        "Homepage": "https://github.com/discsim/frank"
    },
    "split_keywords": [
        "science",
        "astronomy",
        "interferometry"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6f82868b39f290bd1f35775759b1d693f606c7982966fc7566a0404b4b85cc75",
                "md5": "8ce7207d185b424263fc435c898de225",
                "sha256": "951f3b8098f17ac301c95992289e3ba7ffb9dbfa93a7d7fd4f70fc259a8510b9"
            },
            "downloads": -1,
            "filename": "frank-1.2.2.tar.gz",
            "has_sig": false,
            "md5_digest": "8ce7207d185b424263fc435c898de225",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 77897,
            "upload_time": "2023-07-10T12:40:22",
            "upload_time_iso_8601": "2023-07-10T12:40:22.190427Z",
            "url": "https://files.pythonhosted.org/packages/6f/82/868b39f290bd1f35775759b1d693f606c7982966fc7566a0404b4b85cc75/frank-1.2.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-07-10 12:40:22",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "discsim",
    "github_project": "frank",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "frank"
}
        
Elapsed time: 0.09729s