# ironman
ironman is a Python package for jointly fitting in-transit and out-of-transit radial velocities with photometry. Its main objective is measuring stellar obliquities using the Rossiter-McLaughlin effect.
# Installation
You can install ironman with pip
```
pip install ironman-package
```
Or cloning the repository
```
git clone https://github.com/jiespinozar/ironman
cd ironman
pip install .
```
# Examples
To see examples of the usage of this module, see the example notebooks in the Examples folder.
- Example 1: How to fit data with ironman (sky-projected obliquity)
- Example 2: How to simulate data (e.g., for proposals)
- Example 3: How to fit data with ironman (true 3D obliquity)
# Dependencies
- rmfit (pip install rmfit)
- numpy (pip install numpy)
- scipy (pip install scipy)
- pandas (pip install pandas)
- batman-package (pip install batman-package)
- dynesty (pip install dynesty)
- astropy (pip install astropy)
# Citation
If you use this code, please cite [Espinoza-Retamal et al. 2024](https://ui.adsabs.harvard.edu/abs/2024arXiv240618631E/abstract)
If you use the RM fitting capability, please cite [Stefansson et al. 2022](https://ui.adsabs.harvard.edu/abs/2022ApJ...931L..15S/abstract) and [Hirano et al. 2010](https://ui.adsabs.harvard.edu/abs/2010ApJ...709..458H/abstract)
If you use the transit fitting capability, please cite [Kreidberg et al. 2015](https://ui.adsabs.harvard.edu/abs/2015ascl.soft10002K/abstract)
If you use the RV fitting capability, please cite [Fulton et al. 2018](https://ui.adsabs.harvard.edu/abs/2018PASP..130d4504F/abstract)
Raw data
{
"_id": null,
"home_page": "https://github.com/jiespinozar/ironman",
"name": "ironman-package",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "Astronomy, Obliquities, Radial Velocities",
"author": "Juan Ignacio Espinoza-Retamal",
"author_email": "jiespinozar@uc.cl",
"download_url": "https://files.pythonhosted.org/packages/82/fc/5d59f8cc086a1d96854e7a540c95bacfb056dccb7231a8e56500f852f370/ironman_package-1.0.6.tar.gz",
"platform": null,
"description": "# ironman\n\nironman is a Python package for jointly fitting in-transit and out-of-transit radial velocities with photometry. Its main objective is measuring stellar obliquities using the Rossiter-McLaughlin effect.\n\n# Installation\n\nYou can install ironman with pip\n\n```\npip install ironman-package\n```\nOr cloning the repository\n\n```\ngit clone https://github.com/jiespinozar/ironman\ncd ironman\npip install .\n```\n\n# Examples\n\nTo see examples of the usage of this module, see the example notebooks in the Examples folder.\n\n- Example 1: How to fit data with ironman (sky-projected obliquity)\n- Example 2: How to simulate data (e.g., for proposals)\n- Example 3: How to fit data with ironman (true 3D obliquity)\n\n# Dependencies\n\n- rmfit (pip install rmfit)\n- numpy (pip install numpy)\n- scipy (pip install scipy)\n- pandas (pip install pandas)\n- batman-package (pip install batman-package)\n- dynesty (pip install dynesty)\n- astropy (pip install astropy)\n\n# Citation\n\nIf you use this code, please cite [Espinoza-Retamal et al. 2024](https://ui.adsabs.harvard.edu/abs/2024arXiv240618631E/abstract)\n\nIf you use the RM fitting capability, please cite [Stefansson et al. 2022](https://ui.adsabs.harvard.edu/abs/2022ApJ...931L..15S/abstract) and [Hirano et al. 2010](https://ui.adsabs.harvard.edu/abs/2010ApJ...709..458H/abstract)\n\nIf you use the transit fitting capability, please cite [Kreidberg et al. 2015](https://ui.adsabs.harvard.edu/abs/2015ascl.soft10002K/abstract)\n\nIf you use the RV fitting capability, please cite [Fulton et al. 2018](https://ui.adsabs.harvard.edu/abs/2018PASP..130d4504F/abstract)\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Joint Fit Rossiter McLaughlin Data with photometry and out-of-transit radial velocities",
"version": "1.0.6",
"project_urls": {
"Homepage": "https://github.com/jiespinozar/ironman"
},
"split_keywords": [
"astronomy",
" obliquities",
" radial velocities"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "73b361cb01c7a82980a01060133e89dace5f7f3b76da3c08eba5bfde597ff12e",
"md5": "11eccc440f87ff1d38e27715d6e17805",
"sha256": "937260f426ef2156444ec7772b0c02e3785b229e1334391d1cb01e3eda6c4ecb"
},
"downloads": -1,
"filename": "ironman_package-1.0.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "11eccc440f87ff1d38e27715d6e17805",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 12496,
"upload_time": "2025-01-23T16:09:59",
"upload_time_iso_8601": "2025-01-23T16:09:59.529676Z",
"url": "https://files.pythonhosted.org/packages/73/b3/61cb01c7a82980a01060133e89dace5f7f3b76da3c08eba5bfde597ff12e/ironman_package-1.0.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "82fc5d59f8cc086a1d96854e7a540c95bacfb056dccb7231a8e56500f852f370",
"md5": "c3007c265b13f2671742cc5c616c4bb9",
"sha256": "a8a53dfe7327ad6c7819822113f9825caeecf2a6e7e0a92094f4d80e26a83e89"
},
"downloads": -1,
"filename": "ironman_package-1.0.6.tar.gz",
"has_sig": false,
"md5_digest": "c3007c265b13f2671742cc5c616c4bb9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 13280,
"upload_time": "2025-01-23T16:10:02",
"upload_time_iso_8601": "2025-01-23T16:10:02.593571Z",
"url": "https://files.pythonhosted.org/packages/82/fc/5d59f8cc086a1d96854e7a540c95bacfb056dccb7231a8e56500f852f370/ironman_package-1.0.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-23 16:10:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jiespinozar",
"github_project": "ironman",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "ironman-package"
}
JSON
