# 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/57/dc/caf8130efe4f99dd237c206d3744612bf20263fbaa7c144fa1122935aba7/ironman_package-1.0.3.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.3",
"project_urls": {
"Homepage": "https://github.com/jiespinozar/ironman"
},
"split_keywords": [
"astronomy",
" obliquities",
" radial velocities"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3a9da2646ab90a239a4062487980d1b250c54acfc9cd67907693686ddfb3e6e7",
"md5": "52af6eff47cbb01bd6112782c284e6b8",
"sha256": "4b25123a613a100ed3f313516487f05c9887b7c14ae1a3511c33b1951beaf4ae"
},
"downloads": -1,
"filename": "ironman_package-1.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "52af6eff47cbb01bd6112782c284e6b8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 12380,
"upload_time": "2024-10-31T13:28:40",
"upload_time_iso_8601": "2024-10-31T13:28:40.565945Z",
"url": "https://files.pythonhosted.org/packages/3a/9d/a2646ab90a239a4062487980d1b250c54acfc9cd67907693686ddfb3e6e7/ironman_package-1.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "57dccaf8130efe4f99dd237c206d3744612bf20263fbaa7c144fa1122935aba7",
"md5": "d7af0b9b739b9480dd6a815840596ed5",
"sha256": "fb45249f2d44dca293e9d3f0137a971120a829dd1ff5158f55a3fd0c0a17f0a7"
},
"downloads": -1,
"filename": "ironman_package-1.0.3.tar.gz",
"has_sig": false,
"md5_digest": "d7af0b9b739b9480dd6a815840596ed5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 13155,
"upload_time": "2024-10-31T13:28:41",
"upload_time_iso_8601": "2024-10-31T13:28:41.658846Z",
"url": "https://files.pythonhosted.org/packages/57/dc/caf8130efe4f99dd237c206d3744612bf20263fbaa7c144fa1122935aba7/ironman_package-1.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-31 13:28:41",
"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
