fwl-janus


Namefwl-janus JSON
Version 24.11.5 PyPI version JSON
download
home_pageNone
SummaryTemperature structure generator for planetory atmospheres.
upload_time2024-11-05 18:05:11
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseApache 2.0 License
keywords exoplanet atmosphere
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![Documentation Status](https://readthedocs.org/projects/fwl-janus/badge/?version=latest)](https://fwl-janus.readthedocs.io/en/latest/?badge=latest)
![Coverage](https://gist.githubusercontent.com/stefsmeets/99391a66bb9229771504c3a4db611d05/raw/covbadge.svg)

## JANUS (1D convective atmosphere model)

Generates a temperature profile using the generalised moist pseudoadiabat and a prescribed stratosphere. Calculates radiative fluxes using SOCRATES.

Pronounced *jan-us*. *Jan* as in "january", and *us* as in the collective pronoun.

### Documentation
https://fwl-proteus.readthedocs.io

## Contributors

| Name  | Email address |
| -     | -             |
Tim Lichtenberg         | tim.lichtenberg[at]rug.nl |
Harrison Nicholls       | harrison.nicholls[at]physics.ox.ac.uk |
Laurent Soucasse        | l.soucasse[at]esciencecenter.nl |
Stef Smeets             | s.smeets[at]esciencecenter.nl |
Mark Hammond            | mark.hammond[at]physics.ox.ac.uk |
RJ Graham               | arejaygraham[at]uchicago.edu |
Raymond Pierrehumbert   | raymond.pierrehumbert[at]physics.ox.ac.uk |
Ryan Boukrouche         | ryan.boukrouche[at]astro.su.se |
Hamish Innes            | hamish.innes[at]fu-berlin.de |


### Repository structure
* `README.md`           - This file
* `src/janus/data/`     - Janus data files
* `src/janus/modules/`  - Utility python scripts
* `src/janus/utils/`    - Utility python scripts
* `examples/`           - Typical use scripts
* `tools/`              - Useful tools

### Developer installation instructions
1. Download and install Socrates
```console
git clone git@github.com:nichollsh/SOCRATES.git
cd SOCRATES
./configure
./build-code
source set_rad_env
cd ..
```
2. Download and install Janus
```console
git clone git@github.com:FormingWorlds/JANUS.git
cd JANUS
pip install -e .
```
3. Download data from the [OSF repository](https://osf.io/vehxg/)
    * Set the environment variable FWL_DATA to define where the spectral data files will be stored
        * `export FWL_DATA=...`
    * Run the following commands to download all basic data
        * `janus download spectral`
        * `janus download stellar`
    * Alternatively, you can specify which spectral data you want to download, and optionally the number of bands
        * `janus download spectral -n Frostflow -b 4096`

### Run instructions
In the examples folder you can find python scripts showing typical usecases/workflows of atmosphere modelling with Janus.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "fwl-janus",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "exoplanet, atmosphere",
    "author": null,
    "author_email": "Tim Lichtenberg <tim.lichtenberg@rug.nl>, Mark Hammond <mark.hammond@physics.ox.ac.uk>, Ryan Boukrouche <ryan.boukrouche@astro.su.se>, RJ Graham <arejaygraham@uchicago.edu>, Harrison Nicholls <harrison.nicholls@physics.ox.ac.uk>, Hamish Innes <hamish.innes@physics.ox.ac.uk>, Laurent Soucasse <l.soucasse@esciencecenter.nl>",
    "download_url": "https://files.pythonhosted.org/packages/76/43/7a553879ef4486e2e1522f19275a1a4ccae07e58546447ecd0ccdb2b6f53/fwl_janus-24.11.5.tar.gz",
    "platform": null,
    "description": "[![Documentation Status](https://readthedocs.org/projects/fwl-janus/badge/?version=latest)](https://fwl-janus.readthedocs.io/en/latest/?badge=latest)\n![Coverage](https://gist.githubusercontent.com/stefsmeets/99391a66bb9229771504c3a4db611d05/raw/covbadge.svg)\n\n## JANUS (1D convective atmosphere model)\n\nGenerates a temperature profile using the generalised moist pseudoadiabat and a prescribed stratosphere. Calculates radiative fluxes using SOCRATES.\n\nPronounced *jan-us*. *Jan* as in \"january\", and *us* as in the collective pronoun.\n\n### Documentation\nhttps://fwl-proteus.readthedocs.io\n\n## Contributors\n\n| Name  | Email address |\n| -     | -             |\nTim Lichtenberg         | tim.lichtenberg[at]rug.nl |\nHarrison Nicholls       | harrison.nicholls[at]physics.ox.ac.uk |\nLaurent Soucasse        | l.soucasse[at]esciencecenter.nl |\nStef Smeets             | s.smeets[at]esciencecenter.nl |\nMark Hammond            | mark.hammond[at]physics.ox.ac.uk |\nRJ Graham               | arejaygraham[at]uchicago.edu |\nRaymond Pierrehumbert   | raymond.pierrehumbert[at]physics.ox.ac.uk |\nRyan Boukrouche         | ryan.boukrouche[at]astro.su.se |\nHamish Innes            | hamish.innes[at]fu-berlin.de |\n\n\n### Repository structure\n* `README.md`           - This file\n* `src/janus/data/`     - Janus data files\n* `src/janus/modules/`  - Utility python scripts\n* `src/janus/utils/`    - Utility python scripts\n* `examples/`           - Typical use scripts\n* `tools/`              - Useful tools\n\n### Developer installation instructions\n1. Download and install Socrates\n```console\ngit clone git@github.com:nichollsh/SOCRATES.git\ncd SOCRATES\n./configure\n./build-code\nsource set_rad_env\ncd ..\n```\n2. Download and install Janus\n```console\ngit clone git@github.com:FormingWorlds/JANUS.git\ncd JANUS\npip install -e .\n```\n3. Download data from the [OSF repository](https://osf.io/vehxg/)\n    * Set the environment variable FWL_DATA to define where the spectral data files will be stored\n        * `export FWL_DATA=...`\n    * Run the following commands to download all basic data\n        * `janus download spectral`\n        * `janus download stellar`\n    * Alternatively, you can specify which spectral data you want to download, and optionally the number of bands\n        * `janus download spectral -n Frostflow -b 4096`\n\n### Run instructions\nIn the examples folder you can find python scripts showing typical usecases/workflows of atmosphere modelling with Janus.\n",
    "bugtrack_url": null,
    "license": "Apache 2.0 License",
    "summary": "Temperature structure generator for planetory atmospheres.",
    "version": "24.11.5",
    "project_urls": {
        "homepage": "https://github.com/FormingWorlds/JANUS"
    },
    "split_keywords": [
        "exoplanet",
        " atmosphere"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d36802a1ba83d4a4c22d6fa1b870092a6072033240ca757db3f6ee8cd94818e2",
                "md5": "7307d946c2bbb05cc7a60ff6cc9c4075",
                "sha256": "a47e9a42b0f48b98af91def3bf255ccf660a89efc92bcb3f7934a878fe805a9c"
            },
            "downloads": -1,
            "filename": "fwl_janus-24.11.5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7307d946c2bbb05cc7a60ff6cc9c4075",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 156057,
            "upload_time": "2024-11-05T18:05:09",
            "upload_time_iso_8601": "2024-11-05T18:05:09.031379Z",
            "url": "https://files.pythonhosted.org/packages/d3/68/02a1ba83d4a4c22d6fa1b870092a6072033240ca757db3f6ee8cd94818e2/fwl_janus-24.11.5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "76437a553879ef4486e2e1522f19275a1a4ccae07e58546447ecd0ccdb2b6f53",
                "md5": "2457f87321b7281492f6d2a330d8af55",
                "sha256": "c303f86d070bfb0346c5e8a0147ea054c54b46660265a48c2f1d6d285a74d526"
            },
            "downloads": -1,
            "filename": "fwl_janus-24.11.5.tar.gz",
            "has_sig": false,
            "md5_digest": "2457f87321b7281492f6d2a330d8af55",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 147342,
            "upload_time": "2024-11-05T18:05:11",
            "upload_time_iso_8601": "2024-11-05T18:05:11.006392Z",
            "url": "https://files.pythonhosted.org/packages/76/43/7a553879ef4486e2e1522f19275a1a4ccae07e58546447ecd0ccdb2b6f53/fwl_janus-24.11.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-05 18:05:11",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "FormingWorlds",
    "github_project": "JANUS",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "fwl-janus"
}
        
Elapsed time: 1.41323s