oimodeler


Nameoimodeler JSON
Version 0.8.1 PyPI version JSON
download
home_page
SummaryOptical interferometry modelling tool
upload_time2023-07-12 12:32:46
maintainer
docs_urlNone
author
requires_python>=3.8
licenseGPLv3
keywords optical interferometry modeling
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <h1 align="center">
<img src="images/oimodelerlogo.png" width="600">
</h1><br>

[![License: GNU](https://img.shields.io/badge/License-GNU-yellow.svg)](https://www.gnu.org/licenses/gpl-3.0.en.html)
![Lifecycle:
Early Development](https://img.shields.io/badge/lifecycle-EarlyDevelopment-orange.svg)

Oimodeler is a modular modelling tool for optical interferometry


* Installation: https://oimodeler.readthedocs.io/en/latest/installation.html
* Usage: https://oimodeler.readthedocs.io/en/latest/getting_started.html
* Documentation https://oimodeler.readthedocs.io/en/latest/
* Contributing: https://oimodeler.readthedocs.io/en/latest/expandingSoftware.html
* Source code: https://github.com/oimodeler/oimodeler
* Bug reports: https://github.com/oimodeler/oimodeler/issues

## Features
### Modules:
* **oimModel** : Create models with various components as bricks
* **oimComponent** : component for building models
* **oimParam** : Component parameters and parameters interpolators
* **oimData** :  Handle interferometric, spectroscopic and photometric data
* **oimDataFilter** : Filtering and modifying data (wavlengths range cut, smoothing, removing flags...)
* **oimSimulator** : Main class holding evertyhing together and producing final results :plots, tables...
* **oimFitter** : Define and perform model-fitting
* **oimPlot** : Plotting tools
* **oimUtils** : Various utility for optical-interferometry

### :warning: Under Development :warning:
The following modules have only been partially implemented
* oimModel:  Basic functionnalities for building model from all kind of components 
* oimComponent: Many basics Fourier-based components, possiblity to build radial profile and images based components, import of image at fits format and a few advanced components (kinematic disk, fast-rotator)
* oimParam: Possibility to link parameters, normalize them and various interpolators in wavelength and time
* oimData: Interferometric data and basic wrapper for photometric/spectroscopic data
* oimDataFilter: Wavelength range cut and shift, data smoothing and binning, datatype selection, flagging based on criteria
* oimSimulator: Simulated data and chi2 computation with filtering
* oimFitter:  Basic MCMC fitter based on emcee module.
* oimPlot: Various plots for oifits data (see examples below)
* oimUtils: Helpers for oifits format: retrieve baselines info, create new tables, manipulated data...
)

## Examples

For more examples see: https://oimodeler.readthedocs.io/en/latest/examples.html

> Various example scripts are available in the `examples` directory.<br>

This plot has been created with the `createModelChromatic.py` script:

![boo](./images/createModelChromatic.png)

Here is the resulting plot from the `oimodel_Create_simulator_data.py` script.
It plots data of a partly resolved binary created with:
- the [ASPRO](https://www.jmmc.fr/english/tools/proposal-preparation/aspro/) software from JMMC (including realistic noise)
- oimodeler using a shifted uniform disk + unresolved component

![boo](./images/oimodel_Create_simulator_data.png)

Here is a plot showing a model consisting of a fast rotating star plus a uniform disk.
Chromatic images of fast rotator are computed with an external function encapsulated into a oimodeler component.
The uniform disk is a simple Fourier-based component. The code is in the `createCustomComponentImageFastRotator.py`

![boo](./images/customCompImageFastRotatorImageAndVis.png)

## Contact
[Anthony Meilland](https://github.com/AnthonyMeilland)

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "oimodeler",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "optical,interferometry,modeling",
    "author": "",
    "author_email": "Anthony meilland <ame@oca.eu>",
    "download_url": "https://files.pythonhosted.org/packages/9a/e8/284bb50261a91c3fb3aaa3459ec28c4b25dfc6295b931d0f7399ab6b4a3e/oimodeler-0.8.1.tar.gz",
    "platform": null,
    "description": "<h1 align=\"center\">\n<img src=\"images/oimodelerlogo.png\" width=\"600\">\n</h1><br>\n\n[![License: GNU](https://img.shields.io/badge/License-GNU-yellow.svg)](https://www.gnu.org/licenses/gpl-3.0.en.html)\n![Lifecycle:\nEarly Development](https://img.shields.io/badge/lifecycle-EarlyDevelopment-orange.svg)\n\nOimodeler is a modular modelling tool for optical interferometry\n\n\n* Installation: https://oimodeler.readthedocs.io/en/latest/installation.html\n* Usage: https://oimodeler.readthedocs.io/en/latest/getting_started.html\n* Documentation https://oimodeler.readthedocs.io/en/latest/\n* Contributing: https://oimodeler.readthedocs.io/en/latest/expandingSoftware.html\n* Source code: https://github.com/oimodeler/oimodeler\n* Bug reports: https://github.com/oimodeler/oimodeler/issues\n\n## Features\n### Modules:\n* **oimModel** : Create models with various components as bricks\n* **oimComponent** : component for building models\n* **oimParam** : Component parameters and parameters interpolators\n* **oimData** :  Handle interferometric, spectroscopic and photometric data\n* **oimDataFilter** : Filtering and modifying data (wavlengths range cut, smoothing, removing flags...)\n* **oimSimulator** : Main class holding evertyhing together and producing final results :plots, tables...\n* **oimFitter** : Define and perform model-fitting\n* **oimPlot** : Plotting tools\n* **oimUtils** : Various utility for optical-interferometry\n\n### :warning: Under Development :warning:\nThe following modules have only been partially implemented\n* oimModel:  Basic functionnalities for building model from all kind of components \n* oimComponent: Many basics Fourier-based components, possiblity to build radial profile and images based components, import of image at fits format and a few advanced components (kinematic disk, fast-rotator)\n* oimParam: Possibility to link parameters, normalize them and various interpolators in wavelength and time\n* oimData: Interferometric data and basic wrapper for photometric/spectroscopic data\n* oimDataFilter: Wavelength range cut and shift, data smoothing and binning, datatype selection, flagging based on criteria\n* oimSimulator: Simulated data and chi2 computation with filtering\n* oimFitter:  Basic MCMC fitter based on emcee module.\n* oimPlot: Various plots for oifits data (see examples below)\n* oimUtils: Helpers for oifits format: retrieve baselines info, create new tables, manipulated data...\n)\n\n## Examples\n\nFor more examples see: https://oimodeler.readthedocs.io/en/latest/examples.html\n\n> Various example scripts are available in the `examples` directory.<br>\n\nThis plot has been created with the `createModelChromatic.py` script:\n\n![boo](./images/createModelChromatic.png)\n\nHere is the resulting plot from the `oimodel_Create_simulator_data.py` script.\nIt plots data of a partly resolved binary created with:\n- the [ASPRO](https://www.jmmc.fr/english/tools/proposal-preparation/aspro/) software from JMMC (including realistic noise)\n- oimodeler using a shifted uniform disk + unresolved component\n\n![boo](./images/oimodel_Create_simulator_data.png)\n\nHere is a plot showing a model consisting of a fast rotating star plus a uniform disk.\nChromatic images of fast rotator are computed with an external function encapsulated into a oimodeler component.\nThe uniform disk is a simple Fourier-based component. The code is in the `createCustomComponentImageFastRotator.py`\n\n![boo](./images/customCompImageFastRotatorImageAndVis.png)\n\n## Contact\n[Anthony Meilland](https://github.com/AnthonyMeilland)\n",
    "bugtrack_url": null,
    "license": "GPLv3",
    "summary": "Optical interferometry modelling tool",
    "version": "0.8.1",
    "project_urls": {
        "Github": "https://gitlab.oca.eu/oimodeler/oimodeler"
    },
    "split_keywords": [
        "optical",
        "interferometry",
        "modeling"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d9be6009208de992c3e1ce7bec3f8ef718c751dd1376c69399a9ee3f3c0974a0",
                "md5": "ccfe6e4290139c5bad5c62673764c2f1",
                "sha256": "b92d9b8aa8c09f3463679dc13a3ea51e18676f1f268bf1f75e578022d56665c5"
            },
            "downloads": -1,
            "filename": "oimodeler-0.8.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ccfe6e4290139c5bad5c62673764c2f1",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 73763,
            "upload_time": "2023-07-12T12:32:44",
            "upload_time_iso_8601": "2023-07-12T12:32:44.904680Z",
            "url": "https://files.pythonhosted.org/packages/d9/be/6009208de992c3e1ce7bec3f8ef718c751dd1376c69399a9ee3f3c0974a0/oimodeler-0.8.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9ae8284bb50261a91c3fb3aaa3459ec28c4b25dfc6295b931d0f7399ab6b4a3e",
                "md5": "f6c59fcc858add49dcd668afcbe4f497",
                "sha256": "833f305b2908e572ee495462a970a4742d5a2898765a4db173f1fdb4dbf1795d"
            },
            "downloads": -1,
            "filename": "oimodeler-0.8.1.tar.gz",
            "has_sig": false,
            "md5_digest": "f6c59fcc858add49dcd668afcbe4f497",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 67909,
            "upload_time": "2023-07-12T12:32:46",
            "upload_time_iso_8601": "2023-07-12T12:32:46.935268Z",
            "url": "https://files.pythonhosted.org/packages/9a/e8/284bb50261a91c3fb3aaa3459ec28c4b25dfc6295b931d0f7399ab6b4a3e/oimodeler-0.8.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-07-12 12:32:46",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "oimodeler"
}
        
Elapsed time: 0.09957s