# drpangloss
[![PyPI version](https://badge.fury.io/py/drpangloss.svg)](https://badge.fury.io/py/drpangloss)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![integration](https://github.com/benjaminpope/drpangloss/actions/workflows/tests.yml/badge.svg)](https://github.com/benjaminpope/drpangloss/actions/workflows/tests.yml)
[![Documentation](https://github.com/benjaminpope/drpangloss/actions/workflows/documentation.yml/badge.svg)](https://benjaminpope.github.io/drpangloss/)
the best of all possible interferometry models
Contributors: Dori Blakely, [Benjamin Pope](https://github.com/benjaminpope)
## What is drpangloss?
drpangloss is a package for modelling optical interferometry data in Jax.
## Installation
drpangloss is hosted on PyPI (though this is currently a placeholder): the easiest way to install this is with
```
pip install drpangloss
```
You can also build from source. To do so, clone the git repo, enter the directory, and run
```
pip install .
```
We encourage the creation of a virtual enironment to run drpangloss to prevent software conflicts as we keep the software up to date with the lastest version of the core packages.
## Use & Documentation
Documentation will be found [here](https://benjaminpope.github.io/drpangloss/), though this is currently a placeholder.
## Collaboration & Development
We are always looking to collaborate and further develop this software! We have focused on flexibility and ease of development, so if you have a project you want to use drpangloss for, but it currently does not have the required capabilities, don't hesitate to [email me](b.pope@uq.edu.au) and we can discuss how to implement and merge it! Similarly you can take a look at the `CONTRIBUTING.md` file.
## Name
Why is it called drpangloss?
The leading optical interferometry model fitting code is [CANDID](https://github.com/amerand/CANDID). In Voltaire's *Candide*, Dr Pangloss' belief that we live in the best of all possible worlds is a satire of Leibniz' theodicy. But we *do* live in a world with Jax, so that if we can't optimize the world, at least we can optimize our fits to VLTI data.
Raw data
{
"_id": null,
"home_page": "",
"name": "drpangloss",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "python,optics,machine-learning,jax,autodiff,differentiable,diffraction,simulation,telescope,drpangloss",
"author": "",
"author_email": "Benjamin Pope <b.pope@uq.edu.au>, Dori Blakely <blakelyd@uvic.ca>",
"download_url": "https://files.pythonhosted.org/packages/be/41/035856a0ab6a9f5f2dbb9ff3459c688c9f9df20c13756354ceafe2648d6a/drpangloss-0.0.1.tar.gz",
"platform": null,
"description": "# drpangloss\n[![PyPI version](https://badge.fury.io/py/drpangloss.svg)](https://badge.fury.io/py/drpangloss)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![integration](https://github.com/benjaminpope/drpangloss/actions/workflows/tests.yml/badge.svg)](https://github.com/benjaminpope/drpangloss/actions/workflows/tests.yml)\n[![Documentation](https://github.com/benjaminpope/drpangloss/actions/workflows/documentation.yml/badge.svg)](https://benjaminpope.github.io/drpangloss/)\n\nthe best of all possible interferometry models\n\nContributors: Dori Blakely, [Benjamin Pope](https://github.com/benjaminpope)\n\n## What is drpangloss?\n\ndrpangloss is a package for modelling optical interferometry data in Jax.\n\n## Installation\n\ndrpangloss is hosted on PyPI (though this is currently a placeholder): the easiest way to install this is with \n\n```\npip install drpangloss\n```\n\nYou can also build from source. To do so, clone the git repo, enter the directory, and run\n\n```\npip install .\n```\n\nWe encourage the creation of a virtual enironment to run drpangloss to prevent software conflicts as we keep the software up to date with the lastest version of the core packages.\n\n\n## Use & Documentation\n\nDocumentation will be found [here](https://benjaminpope.github.io/drpangloss/), though this is currently a placeholder. \n\n## Collaboration & Development\n\nWe are always looking to collaborate and further develop this software! We have focused on flexibility and ease of development, so if you have a project you want to use drpangloss for, but it currently does not have the required capabilities, don't hesitate to [email me](b.pope@uq.edu.au) and we can discuss how to implement and merge it! Similarly you can take a look at the `CONTRIBUTING.md` file.\n\n## Name\n\nWhy is it called drpangloss?\n\nThe leading optical interferometry model fitting code is [CANDID](https://github.com/amerand/CANDID). In Voltaire's *Candide*, Dr Pangloss' belief that we live in the best of all possible worlds is a satire of Leibniz' theodicy. But we *do* live in a world with Jax, so that if we can't optimize the world, at least we can optimize our fits to VLTI data. \n",
"bugtrack_url": null,
"license": "",
"summary": "Python package to fit interferometric data, accelerated using Jax.",
"version": "0.0.1",
"project_urls": {
"repository": "https://github.com/benjaminpope/drpangloss"
},
"split_keywords": [
"python",
"optics",
"machine-learning",
"jax",
"autodiff",
"differentiable",
"diffraction",
"simulation",
"telescope",
"drpangloss"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "644040237698773f347416694ce6e52198e3f44929da9124e44146076b7a90fb",
"md5": "65ec9b19aba13ea118999ef651f4924e",
"sha256": "8752fe8eddf07d28f233d952879855c708efa7fb15a8792f32b2549977f60783"
},
"downloads": -1,
"filename": "drpangloss-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "65ec9b19aba13ea118999ef651f4924e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 14756,
"upload_time": "2024-02-23T05:43:13",
"upload_time_iso_8601": "2024-02-23T05:43:13.060938Z",
"url": "https://files.pythonhosted.org/packages/64/40/40237698773f347416694ce6e52198e3f44929da9124e44146076b7a90fb/drpangloss-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "be41035856a0ab6a9f5f2dbb9ff3459c688c9f9df20c13756354ceafe2648d6a",
"md5": "787dbc69fdd672b95291ff8d5745c82b",
"sha256": "ddf2a44a96e48ffcb2821b30b2b23b5f51869daec99196f0874b4eb6d04430bb"
},
"downloads": -1,
"filename": "drpangloss-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "787dbc69fdd672b95291ff8d5745c82b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 15120,
"upload_time": "2024-02-23T05:43:15",
"upload_time_iso_8601": "2024-02-23T05:43:15.156439Z",
"url": "https://files.pythonhosted.org/packages/be/41/035856a0ab6a9f5f2dbb9ff3459c688c9f9df20c13756354ceafe2648d6a/drpangloss-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-23 05:43:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "benjaminpope",
"github_project": "drpangloss",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "drpangloss"
}