# pytmosph3r
Pytmosph3R is a Python-3 library that computes transmission spectra based on 3D atmospheric simulations, for example performed with the LMDZ generic global climate model.
## Prerequisites
* numpy
## Installing from PyPI
Pytmosph3r is available on the PyPI repository. You can install the latest version avaible with:
```
pip install pytmosph3r
```
Don't forget to install numpy beforehand.
## Installing from source
If you intend to develop or get the latest (unreleased) developments, you can clone (and move in) the current repository and then install Pytmosph3R using:
```
pip install -e .
```
Don't forget to update `pip` if errors are raised.
To generate the documentation, you will need to install the following packages:
```
pip install nbsphinx sphinx-autoapi sphinx_rtd_theme sphinxcontrib-bibtex sphinx-argparse
conda install sphinx pandoc # installs more (required) dependencies than pip
```
You can then generate the documentation by running:
```
python setup.py doc
```
(or by simply running `make` in the `doc/` folder). The documentation will be generated in the doc/html folder (you can open the [index.html](doc/html/index.html) file to check it out using your favorite browser).
Note that you need to set the environment variable `FASTCHEM_DIR` to the location of the folder containing [FastChem](https://github.com/exoclime/FastChem) if you want to use that functionality (WIP).
## Running
To get help:
```
pytmosph3r -h
```
See the [documentation](http://perso.astrophy.u-bordeaux.fr/~jleconte/pytmosph3r-doc/index.html) for more information (read instructions in `Installation` just above to generate the doc).
Raw data
{
"_id": null,
"home_page": "https://forge.oasu.u-bordeaux.fr/LAB/whiplash/pytmosph3r-2",
"name": "pytmosph3r",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<3.12",
"maintainer_email": "",
"keywords": "exoplanet,simulation,pytmosph3r,spectra,atmosphere,atmospheric",
"author": "Aur\u00e9lien Falco",
"author_email": "aurelien.falco@u-bordeaux.fr",
"download_url": "https://files.pythonhosted.org/packages/ed/59/c623e437faf3bece8ee6a547d70a63ffdc93b75072e563ad9452cfbe22e5/pytmosph3r-2.2.0.tar.gz",
"platform": null,
"description": "# pytmosph3r\n\nPytmosph3R is a Python-3 library that computes transmission spectra based on 3D atmospheric simulations, for example performed with the LMDZ generic global climate model.\n\n## Prerequisites\n\n* numpy\n\n## Installing from PyPI\n\nPytmosph3r is available on the PyPI repository. You can install the latest version avaible with:\n```\npip install pytmosph3r\n```\nDon't forget to install numpy beforehand.\n\n## Installing from source\n\nIf you intend to develop or get the latest (unreleased) developments, you can clone (and move in) the current repository and then install Pytmosph3R using:\n```\npip install -e .\n```\n\nDon't forget to update `pip` if errors are raised.\n\nTo generate the documentation, you will need to install the following packages:\n```\npip install nbsphinx sphinx-autoapi sphinx_rtd_theme sphinxcontrib-bibtex sphinx-argparse\nconda install sphinx pandoc # installs more (required) dependencies than pip\n```\nYou can then generate the documentation by running:\n```\npython setup.py doc\n```\n(or by simply running `make` in the `doc/` folder). The documentation will be generated in the doc/html folder (you can open the [index.html](doc/html/index.html) file to check it out using your favorite browser).\n\nNote that you need to set the environment variable `FASTCHEM_DIR` to the location of the folder containing [FastChem](https://github.com/exoclime/FastChem) if you want to use that functionality (WIP).\n\n## Running\n\nTo get help:\n```\npytmosph3r -h\n```\n\nSee the [documentation](http://perso.astrophy.u-bordeaux.fr/~jleconte/pytmosph3r-doc/index.html) for more information (read instructions in `Installation` just above to generate the doc).\n",
"bugtrack_url": null,
"license": "BSD",
"summary": "Pytmosph3R, generating transmission spectra from 3D atmospheric simulations",
"version": "2.2.0",
"project_urls": {
"Homepage": "https://forge.oasu.u-bordeaux.fr/LAB/whiplash/pytmosph3r-2",
"Repository": "https://forge.oasu.u-bordeaux.fr/LAB/whiplash/pytmosph3r-2"
},
"split_keywords": [
"exoplanet",
"simulation",
"pytmosph3r",
"spectra",
"atmosphere",
"atmospheric"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0295ca54f3509893947c868f84f9be8465d20a7045071a9a91fa30a2d14fec50",
"md5": "7b7d3e66746223972c8fcc227dc9adfb",
"sha256": "a6d958c77fa5db46913ce32ca62bfc2d3c51d5e9f5d7319785816d6c64c88b7e"
},
"downloads": -1,
"filename": "pytmosph3r-2.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7b7d3e66746223972c8fcc227dc9adfb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<3.12",
"size": 145709,
"upload_time": "2023-10-31T15:40:42",
"upload_time_iso_8601": "2023-10-31T15:40:42.883833Z",
"url": "https://files.pythonhosted.org/packages/02/95/ca54f3509893947c868f84f9be8465d20a7045071a9a91fa30a2d14fec50/pytmosph3r-2.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ed59c623e437faf3bece8ee6a547d70a63ffdc93b75072e563ad9452cfbe22e5",
"md5": "c43658c27a39e6d9c10b73f90094acae",
"sha256": "bdbdcf63a1bd457080ab316f83384685c521f753aa1bc5a24cae5bd55e7f8362"
},
"downloads": -1,
"filename": "pytmosph3r-2.2.0.tar.gz",
"has_sig": false,
"md5_digest": "c43658c27a39e6d9c10b73f90094acae",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<3.12",
"size": 117774,
"upload_time": "2023-10-31T15:40:49",
"upload_time_iso_8601": "2023-10-31T15:40:49.995650Z",
"url": "https://files.pythonhosted.org/packages/ed/59/c623e437faf3bece8ee6a547d70a63ffdc93b75072e563ad9452cfbe22e5/pytmosph3r-2.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-31 15:40:49",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pytmosph3r"
}
JSON