.. image:: https://cryo-tools.org/wp-content/uploads/2019/11/COSIPY-logo-2500px.png
The coupled snowpack and ice surface energy and mass balance model in Python COSIPY solves the energy balance at the surface and is coupled to an adaptive vertical multi-layer subsurface module.
Documentation
-------------
The documentation for COSIPY is available at the following link:
https://cosipy.readthedocs.io/en/latest/
**Confused about migrating to the new .toml configuration system?**
The documentation contains an in-depth tutorial and a guide on upgrading.
Convert your existing configuration files before merging the latest update:
.. code-block:: console
pip install toml
git fetch --all
git checkout master -- convert_config.py
python convert_config.py # generate .toml files
This works on any branch regardless of local changes.
Alternatively you can copy and run ``convert_config.py`` into any older COSIPY source tree.
This will preserve your configuration for ``config.py``, ``constants.py``, ``aws2cosipyConfig.py`` and ``wrf2cosipyConfig.py``.
Parameters for ``create_static`` must still be added manually to the generated ``utilities_config.toml``.
Checkout a new branch with a clean version of COSIPY and merge your modifications.
This minimises the number of merge conflicts.
After updating to the latest version of COSIPY, run ``python COSIPY.py --help`` to see how to specify paths to configuration files.
COSIPY will default to ``./config.toml``, ``./constants.toml``, ``./slurm_config.toml``, ``./utilities_config.toml`` in the current working directory.
Installation
------------
Install GDAL:
.. code-block:: console
sudo apt-get install gdal-bin libgdal-dev
pip install --upgrade gdal==`gdal-config --version` pybind11 # with pip
Install COSIPY with pip (for general use):
.. code-block:: console
pip install cosipymodel
cosipy-setup # generate template configuration files
cosipy-help # view help
Install COSIPY from source (for development):
.. code-block:: console
git clone https://github.com/cryotools/cosipy.git
pip install -r requirements.txt # install default environment
pip install -r dev_requirements.txt # install dev environment
conda install --file conda_requirements.txt # install using conda/mamba
python3 COSIPY.py -h
Communication and Support
-------------------------
We are using the groupware slack for communication (inform about new releases, bugs, features, ...) and support:
https://cosipy.slack.com
About
-----
:Tests:
.. image:: https://github.com/cryotools/cosipy/actions/workflows/python-app.yml/badge.svg?branch=master
:target: https://github.com/cryotools/cosipy/actions/workflows/python-app.yml
.. image:: https://readthedocs.org/projects/cosipy/badge/?version=latest
:target: https://cosipy.readthedocs.io/en/latest/
.. image:: http://www.repostatus.org/badges/latest/active.svg
:target: http://www.repostatus.org/#active
.. image:: https://travis-ci.org/cryotools/cosipy.svg?branch=master
:target: https://travis-ci.org/cryotools/cosipy
.. image:: https://codecov.io/gh/cryotools/cosipy/branch/master/graph/badge.svg
:target: https://codecov.io/gh/cryotools/cosipy
:Citation:
.. image:: https://img.shields.io/badge/Citation-GMD%20paper-orange.svg
:target: https://gmd.copernicus.org/articles/13/5645/2020/
.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3902191.svg
:target: https://doi.org/10.5281/zenodo.2579668
:License:
.. image:: https://img.shields.io/badge/License-GPLv3-blue.svg
:target: http://www.gnu.org/licenses/gpl-3.0.en.html
Raw data
{
"_id": null,
"home_page": null,
"name": "cosipymodel",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "energy balance model, glacier modelling, glaciers, glaciology, mass balance",
"author": "COSIPY Contributors",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/5d/bd/27e11ffd1d920fb993d3635f5a3a42ceb87ca35a204f5df940b3fab00c78/cosipymodel-2.0.1.tar.gz",
"platform": null,
"description": ".. image:: https://cryo-tools.org/wp-content/uploads/2019/11/COSIPY-logo-2500px.png\n\nThe coupled snowpack and ice surface energy and mass balance model in Python COSIPY solves the energy balance at the surface and is coupled to an adaptive vertical multi-layer subsurface module.\n\nDocumentation\n-------------\nThe documentation for COSIPY is available at the following link:\nhttps://cosipy.readthedocs.io/en/latest/\n\n**Confused about migrating to the new .toml configuration system?**\nThe documentation contains an in-depth tutorial and a guide on upgrading.\n\nConvert your existing configuration files before merging the latest update:\n\n.. code-block:: console\n\n pip install toml\n git fetch --all\n git checkout master -- convert_config.py\n python convert_config.py # generate .toml files\n\nThis works on any branch regardless of local changes.\nAlternatively you can copy and run ``convert_config.py`` into any older COSIPY source tree.\n\nThis will preserve your configuration for ``config.py``, ``constants.py``, ``aws2cosipyConfig.py`` and ``wrf2cosipyConfig.py``.\nParameters for ``create_static`` must still be added manually to the generated ``utilities_config.toml``.\n\nCheckout a new branch with a clean version of COSIPY and merge your modifications.\nThis minimises the number of merge conflicts.\nAfter updating to the latest version of COSIPY, run ``python COSIPY.py --help`` to see how to specify paths to configuration files.\nCOSIPY will default to ``./config.toml``, ``./constants.toml``, ``./slurm_config.toml``, ``./utilities_config.toml`` in the current working directory.\n\nInstallation\n------------\n\nInstall GDAL:\n\n.. code-block:: console\n\n sudo apt-get install gdal-bin libgdal-dev\n pip install --upgrade gdal==`gdal-config --version` pybind11 # with pip\n\nInstall COSIPY with pip (for general use):\n\n.. code-block:: console\n\n pip install cosipymodel\n cosipy-setup # generate template configuration files\n cosipy-help # view help\n\nInstall COSIPY from source (for development):\n\n.. code-block:: console\n\n git clone https://github.com/cryotools/cosipy.git\n pip install -r requirements.txt # install default environment\n pip install -r dev_requirements.txt # install dev environment\n conda install --file conda_requirements.txt # install using conda/mamba\n python3 COSIPY.py -h\n\nCommunication and Support\n-------------------------\nWe are using the groupware slack for communication (inform about new releases, bugs, features, ...) and support:\nhttps://cosipy.slack.com\n\nAbout\n-----\n\n:Tests:\n .. image:: https://github.com/cryotools/cosipy/actions/workflows/python-app.yml/badge.svg?branch=master\n :target: https://github.com/cryotools/cosipy/actions/workflows/python-app.yml\n\n .. image:: https://readthedocs.org/projects/cosipy/badge/?version=latest\n :target: https://cosipy.readthedocs.io/en/latest/\n\n .. image:: http://www.repostatus.org/badges/latest/active.svg\n :target: http://www.repostatus.org/#active\n\n .. image:: https://travis-ci.org/cryotools/cosipy.svg?branch=master\n :target: https://travis-ci.org/cryotools/cosipy\n\n .. image:: https://codecov.io/gh/cryotools/cosipy/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/cryotools/cosipy\n\n:Citation:\n .. image:: https://img.shields.io/badge/Citation-GMD%20paper-orange.svg\n :target: https://gmd.copernicus.org/articles/13/5645/2020/\n\n .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3902191.svg\n :target: https://doi.org/10.5281/zenodo.2579668\n\n:License:\n .. image:: https://img.shields.io/badge/License-GPLv3-blue.svg\n :target: http://www.gnu.org/licenses/gpl-3.0.en.html\n",
"bugtrack_url": null,
"license": "GPL-3.0",
"summary": "Coupled snowpack and ice surface energy and mass balance model in Python.",
"version": "2.0.1",
"project_urls": {
"Bug Tracker": "https://github.com/cryotools/cosipy/issues",
"Documentation": "https://cosipy.readthedocs.io/en/latest/",
"Homepage": "https://github.com/cryotools/cosipy"
},
"split_keywords": [
"energy balance model",
" glacier modelling",
" glaciers",
" glaciology",
" mass balance"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "857598e2772d06d0f1fa31d8433740fb781971b7da93871baa62e9f55790c9be",
"md5": "be9930df40a4dc7e13ba6fcbef3e0595",
"sha256": "77b6d0461975726b790a41a0d45943f485cce7570ebcf7cf48957ce2a13e813d"
},
"downloads": -1,
"filename": "cosipymodel-2.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "be9930df40a4dc7e13ba6fcbef3e0595",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 138872,
"upload_time": "2024-11-27T13:51:46",
"upload_time_iso_8601": "2024-11-27T13:51:46.479965Z",
"url": "https://files.pythonhosted.org/packages/85/75/98e2772d06d0f1fa31d8433740fb781971b7da93871baa62e9f55790c9be/cosipymodel-2.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5dbd27e11ffd1d920fb993d3635f5a3a42ceb87ca35a204f5df940b3fab00c78",
"md5": "7337cd1169b958ea61d19d22aba32607",
"sha256": "e4c02f08b10f3eaf39a876f69fe421d1952f1d29ae8f72edae05b0ec499607d7"
},
"downloads": -1,
"filename": "cosipymodel-2.0.1.tar.gz",
"has_sig": false,
"md5_digest": "7337cd1169b958ea61d19d22aba32607",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 111246,
"upload_time": "2024-11-27T13:51:48",
"upload_time_iso_8601": "2024-11-27T13:51:48.718900Z",
"url": "https://files.pythonhosted.org/packages/5d/bd/27e11ffd1d920fb993d3635f5a3a42ceb87ca35a204f5df940b3fab00c78/cosipymodel-2.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-27 13:51:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cryotools",
"github_project": "cosipy",
"travis_ci": true,
"coveralls": true,
"github_actions": true,
"requirements": [
{
"name": "numpy",
"specs": [
[
">=",
"2.0"
]
]
},
{
"name": "pandas",
"specs": [
[
">",
"2.0"
]
]
},
{
"name": "scipy",
"specs": [
[
">=",
"1.1.0"
]
]
},
{
"name": "xarray",
"specs": [
[
">=",
"0.18.0"
]
]
},
{
"name": "xarray-spatial",
"specs": []
},
{
"name": "netcdf4",
"specs": [
[
">=",
"1.5.1.2"
]
]
},
{
"name": "distributed",
"specs": [
[
"<=",
"2024.2.0"
]
]
},
{
"name": "distributed",
"specs": []
},
{
"name": "dask",
"specs": []
},
{
"name": "dask-jobqueue",
"specs": []
},
{
"name": "numba",
"specs": []
},
{
"name": "metpy",
"specs": []
},
{
"name": "matplotlib",
"specs": []
},
{
"name": "nco",
"specs": []
},
{
"name": "cdo",
"specs": []
},
{
"name": "cartopy",
"specs": []
},
{
"name": "vtk",
"specs": []
},
{
"name": "richdem",
"specs": []
},
{
"name": "coveralls",
"specs": []
},
{
"name": "codecov",
"specs": []
},
{
"name": "pytest",
"specs": []
},
{
"name": "pytest-dependency",
"specs": []
},
{
"name": "tomli",
"specs": []
}
],
"lcname": "cosipymodel"
}
JSON
