# pymcfost
pymcfost is a python interface to the 3D radiative transfer code mcfost. The goal is to provide a simple and light interface to explore and plot a single (or a few) model(s).
pymcfost offers (or will offer) the following functionalities:
- set up continuum and line models,
- read a single model or library of models,
- plot basic quantities, e.g. density structures, temperature maps on the various grids available in mcfost,
- plot observables : SEDs, image (with convolution), polarisation maps and vectors, visibilities, channels maps (with spatial and spectral convolution), moment maps.
- convert units, e.g. W.m-2 to Jy or brightness temperature
- provides an interface to the ALMA CASA simulator
- provides a fast and simplfied version of the ALMA simulator (spatial convolution with Gaussian, spectral convolution and noise), ie ignoring uv sampling,
- consistent interface with the casa_cube python package to compare observations with models
- read and plot dust models, including Mie, DHS and aggregates dust properties calculations
- (TBD) direct interface to the ML chemical predictions
## Installation:
```
git clone https://github.com/cpinte/pymcfost.git
cd pymcfost
python3 setup.py install
```
If you don't have the `sudo` rights, use `python3 setup.py install --user`.
To install in developer mode: (i.e. using symlinks to point directly
at this directory, so that code changes here are immediately available
without needing to repeat the above step):
```
python3 setup.py develop
```
## History:
In case you are curious, pymcfost was born as an attempt to port in python the functions that were available in the yorick-mcfost code, which is still available here: https://github.com/cpinte/yomcfost.
The fitting routines of the yorick interface are yet to be ported into pymcfost.
An alternative python distribution is available at https://github.com/swolff9/mcfost-python . It is more tailored towards handling large grid of models and model fitting.
## Main structural differences with mcfost-python so far:
- python >= 3.6 vs python 2.x
- only parameter file >= 3.0
- handles parameter files with mutiple zones, dust population, molecules, stars, etc. Parameter files are stored in objects rather than dicts, allowing more flexibility.
- does not and will not handle observational data, only models
Raw data
{
"_id": null,
"home_page": "",
"name": "pymcfost",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "Christophe Pinte",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/5c/b5/a442d68023a8ec56eef78771934a87dc8b64ca06eee0696ef9491d3878f8/pymcfost-0.0.1.tar.gz",
"platform": null,
"description": "# pymcfost\n\npymcfost is a python interface to the 3D radiative transfer code mcfost. The goal is to provide a simple and light interface to explore and plot a single (or a few) model(s).\n\npymcfost offers (or will offer) the following functionalities:\n\n - set up continuum and line models,\n - read a single model or library of models,\n - plot basic quantities, e.g. density structures, temperature maps on the various grids available in mcfost,\n - plot observables : SEDs, image (with convolution), polarisation maps and vectors, visibilities, channels maps (with spatial and spectral convolution), moment maps.\n - convert units, e.g. W.m-2 to Jy or brightness temperature\n - provides an interface to the ALMA CASA simulator\n - provides a fast and simplfied version of the ALMA simulator (spatial convolution with Gaussian, spectral convolution and noise), ie ignoring uv sampling,\n - consistent interface with the casa_cube python package to compare observations with models\n - read and plot dust models, including Mie, DHS and aggregates dust properties calculations\n - (TBD) direct interface to the ML chemical predictions\n\n## Installation:\n\n```\ngit clone https://github.com/cpinte/pymcfost.git\ncd pymcfost\npython3 setup.py install\n```\n\nIf you don't have the `sudo` rights, use `python3 setup.py install --user`.\n\nTo install in developer mode: (i.e. using symlinks to point directly\nat this directory, so that code changes here are immediately available\nwithout needing to repeat the above step):\n\n```\n python3 setup.py develop\n```\n\n## History:\n\nIn case you are curious, pymcfost was born as an attempt to port in python the functions that were available in the yorick-mcfost code, which is still available here: https://github.com/cpinte/yomcfost.\nThe fitting routines of the yorick interface are yet to be ported into pymcfost.\nAn alternative python distribution is available at https://github.com/swolff9/mcfost-python . It is more tailored towards handling large grid of models and model fitting.\n\n## Main structural differences with mcfost-python so far:\n\n- python >= 3.6 vs python 2.x\n- only parameter file >= 3.0\n- handles parameter files with mutiple zones, dust population, molecules, stars, etc. Parameter files are stored in objects rather than dicts, allowing more flexibility.\n- does not and will not handle observational data, only models\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "MCFOST post-processing in Python'",
"version": "0.0.1",
"project_urls": {
"homepage": "http://github.com/cpinte/pymcfost"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5cb5a442d68023a8ec56eef78771934a87dc8b64ca06eee0696ef9491d3878f8",
"md5": "059329102d4131d571364259d6c9307f",
"sha256": "1fc677301ac1aca4c532f63076b4dbbe63d0bbba879ce8c7a088d80928e82a2a"
},
"downloads": -1,
"filename": "pymcfost-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "059329102d4131d571364259d6c9307f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 102574,
"upload_time": "2023-09-08T06:04:08",
"upload_time_iso_8601": "2023-09-08T06:04:08.525921Z",
"url": "https://files.pythonhosted.org/packages/5c/b5/a442d68023a8ec56eef78771934a87dc8b64ca06eee0696ef9491d3878f8/pymcfost-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-08 06:04:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cpinte",
"github_project": "pymcfost",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "numpy",
"specs": []
},
{
"name": "astropy",
"specs": []
},
{
"name": "scipy",
"specs": []
},
{
"name": "matplotlib",
"specs": []
},
{
"name": "progressbar",
"specs": []
}
],
"lcname": "pymcfost"
}
JSON
