Welcome to the documentation about the multimelt package!
=========================================================
.. start-badges
.. list-table::
:stub-columns: 1
:widths: 10 90
* - docs
- |docs|
.. |docs| image:: http://readthedocs.org/projects/multimelt/badge/?version=latest
:alt: Documentation Status
:target: http://multimelt.readthedocs.io/en/latest/?badge=latest
.. end-badges
.. multimelt documentation master file, created by
sphinx-quickstart on Mon Aug 10 11:47:09 2020.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Multimelt contains a large amount of existing basal melt parameterisations for Antarctic ice shelves. The functions are written as such that the main input needed are temperature and salinity profiles in front of the ice shelf, the rest happens in the functions.
Also, multimelt contains functions to create masks of the Antarctic continent and the different ice shelves, and other geographical parameters on a circum-Antarctic scale, for input on a stereographic grid.
To use this package, clone the github repository locally and install it into you python/conda environment via
.. code-block:: bash
pip install .
It contains four example python notebooks:
* ``prepare_mask_example.ipynb`` : a script using geometric circum-Antarctic input to produce masks of the ice shelves, and the needed box characteristics and plume characteristics
* ``conversion_CTtoPT_SAtoSP.ipynb`` : a script to convert 3D fields of conservative temperature to potential temperature and 3D fields of absolute salinity to practical salinity
* ``T_S_profiles_per_ice_shelf.ipynb`` : a script to created averaged temperature and salinity profiles in front of the different ice shelves
* ``compute_melt_example.ipynb`` : a script showing how to apply the melting functions
The documentation can be found here: http://multimelt.readthedocs.io/
Don't hesitate to contact me if any questions arise: clara.burgard@univ-grenoble-alpes.fr
How to cite multimelt
---------------------
The detailed description of the application of the functions in multimelt is found in `Burgard et al., 2022`_ and should therefore, when used, be cited as follows:
Burgard, C., Jourdain, N. C., Reese, R., Jenkins, A., and Mathiot, P. (2022): An assessment of basal melt parameterisations for Antarctic ice shelves, The Cryosphere, https://doi.org/10.5194/tc-16-4931-2022.
.. _`Burgard et al., 2022`: https://doi.org/10.5194/tc-16-4931-2022
Raw data
{
"_id": null,
"home_page": "https://github.com/ClimateClara/multimelt",
"name": "multimelt",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.5",
"maintainer_email": "",
"keywords": "earth-sciences climate-modeling ice-sheet antarctica oceanography",
"author": "Clara Burgard",
"author_email": "clara.burgard@univ-grenoble-alpes.fr",
"download_url": "https://files.pythonhosted.org/packages/39/d3/ed07c3836ebb4e470f3225a2964c516eaac719db4740f8660339a4c8cfdf/multimelt-0.2.tar.gz",
"platform": null,
"description": "Welcome to the documentation about the multimelt package!\n=========================================================\n\n.. start-badges\n\n.. list-table::\n :stub-columns: 1\n :widths: 10 90\n\n * - docs\n - |docs|\n\n.. |docs| image:: http://readthedocs.org/projects/multimelt/badge/?version=latest\n :alt: Documentation Status\n :target: http://multimelt.readthedocs.io/en/latest/?badge=latest\n\n.. end-badges\n\n.. multimelt documentation master file, created by\n sphinx-quickstart on Mon Aug 10 11:47:09 2020.\n You can adapt this file completely to your liking, but it should at least\n contain the root `toctree` directive.\n\n\nMultimelt contains a large amount of existing basal melt parameterisations for Antarctic ice shelves. The functions are written as such that the main input needed are temperature and salinity profiles in front of the ice shelf, the rest happens in the functions.\n\nAlso, multimelt contains functions to create masks of the Antarctic continent and the different ice shelves, and other geographical parameters on a circum-Antarctic scale, for input on a stereographic grid. \n\nTo use this package, clone the github repository locally and install it into you python/conda environment via \n\n.. code-block:: bash\n \n pip install .\n\nIt contains four example python notebooks:\n\n* ``prepare_mask_example.ipynb`` : a script using geometric circum-Antarctic input to produce masks of the ice shelves, and the needed box characteristics and plume characteristics\n* ``conversion_CTtoPT_SAtoSP.ipynb`` : a script to convert 3D fields of conservative temperature to potential temperature and 3D fields of absolute salinity to practical salinity\n* ``T_S_profiles_per_ice_shelf.ipynb`` : a script to created averaged temperature and salinity profiles in front of the different ice shelves\n* ``compute_melt_example.ipynb`` : a script showing how to apply the melting functions\n\n\nThe documentation can be found here: http://multimelt.readthedocs.io/\n\nDon't hesitate to contact me if any questions arise: clara.burgard@univ-grenoble-alpes.fr\n\nHow to cite multimelt\n---------------------\n\nThe detailed description of the application of the functions in multimelt is found in `Burgard et al., 2022`_ and should therefore, when used, be cited as follows:\n\nBurgard, C., Jourdain, N. C., Reese, R., Jenkins, A., and Mathiot, P. (2022): An assessment of basal melt parameterisations for Antarctic ice shelves, The Cryosphere, https://doi.org/10.5194/tc-16-4931-2022. \n\n\n.. _`Burgard et al., 2022`: https://doi.org/10.5194/tc-16-4931-2022\n\n\n\n",
"bugtrack_url": null,
"license": "GPL-3.0",
"summary": "Regroupment of the main existing ice shelf basal melt parameterisations",
"version": "0.2",
"project_urls": {
"Homepage": "https://github.com/ClimateClara/multimelt",
"Source": "https://github.com/ClimateClara/multimelt",
"Tracker": "https://github.com/ClimateClara/multimelt/issues"
},
"split_keywords": [
"earth-sciences",
"climate-modeling",
"ice-sheet",
"antarctica",
"oceanography"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "39d3ed07c3836ebb4e470f3225a2964c516eaac719db4740f8660339a4c8cfdf",
"md5": "7ac39dcf1c33a34cbaab8ad2b6afa8fa",
"sha256": "ee3892b07fb1835590ae5185469094dcd44432dfd024cd35d6c29ee1da59bfad"
},
"downloads": -1,
"filename": "multimelt-0.2.tar.gz",
"has_sig": false,
"md5_digest": "7ac39dcf1c33a34cbaab8ad2b6afa8fa",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.5",
"size": 57955,
"upload_time": "2023-05-22T12:54:22",
"upload_time_iso_8601": "2023-05-22T12:54:22.133348Z",
"url": "https://files.pythonhosted.org/packages/39/d3/ed07c3836ebb4e470f3225a2964c516eaac719db4740f8660339a4c8cfdf/multimelt-0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-22 12:54:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ClimateClara",
"github_project": "multimelt",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "multimelt"
}
JSON
