cosipy

Solves the energy balance at the surface and is coupled to an adaptive vertical multi-layer subsurface module.
https://github.com/cryotools/cosipy

Category: Cryosphere
Sub Category: Glacier and Ice Sheets

Last synced: about 19 hours ago
JSON representation

Repository metadata

Coupled snowpack and ice surface energy and mass balance model in Python

• Host: GitHub
• URL: https://github.com/cryotools/cosipy
• Owner: cryotools
• License: gpl-3.0
• Created: 2017-10-23T14:10:03.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-12-03T14:11:34.000Z (5 months ago)
• Last Synced: 2025-03-15T17:02:58.310Z (about 1 month ago)
• Language: Python
• Homepage:
• Size: 249 MB
• Stars: 55
• Watchers: 15
• Forks: 35
• Open Issues: 28
• Releases: 8
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

README.rst

          .. 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
    conda install gdal  # with conda

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 as an editable (recommended for development):

.. code-block:: console

    git clone https://github.com/cryotools/cosipy.git
    cd cosipy    
    make install          # using conda/mamba
    make install-pip-dev  # using pip

    cosipy-help           # view help

Install COSIPY from source (for development):

.. code-block:: console

    git clone https://github.com/cryotools/cosipy.git
    cd cosipy
    make install-conda-envs                      # install using conda/mamba
    conda install --file conda_requirements.txt  # install with conda

    pip install -r requirements.txt              # install default environment
    pip install -r dev_requirements.txt          # install dev environment

    python3 COSIPY.py -h
    make commands

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

        

---

Owner metadata

• Name: CryoTools
• Login: cryotools
• Email:
• Kind: organization
• Description: Scientific software tools to investigate the cryosphere - community driven, free, open source
• Website: https://cryo-tools.org
• Location:
• Twitter: CryoTools
• Company:
• Icon url: https://avatars.githubusercontent.com/u/33029607?v=4
• Repositories: 12
• Last ynced at: 2024-05-11T05:49:39.658Z
• Profile URL: https://github.com/cryotools

---

GitHub Events

Total

• Create event: 9
• Release event: 3
• Issues event: 21
• Watch event: 7
• Delete event: 14
• Member event: 1
• Issue comment event: 28
• Push event: 62
• Pull request event: 22
• Fork event: 7

Last Year

• Create event: 9
• Release event: 3
• Issues event: 21
• Watch event: 7
• Delete event: 14
• Member event: 1
• Issue comment event: 28
• Push event: 62
• Pull request event: 22
• Fork event: 7

---

Committers metadata

Last synced: 5 days ago

Name	Email	Commits
AnsArn	a****t@g****e	254
gampnico	4****o	181
Tobias Sauter	t****r@u****t	94
Emily Collier	e****r@f****e	48
Anselm-Arndt	3****t	40
apfelbuzza	3****a	22
Tobias Sauter	g****1@m****e	15
AnsArn	y****u@e****m	14
Björn Saß	b****s@f****e	10
Marcus Gastaldello	1****o	6
anz	a****t@g****e	6
5ling5h0t	d****l@g****e	5
Benjamin Schmidt	b****t@l****e	4
tobias sauter	t****r@t****e	4
tobias sauter	t****r@f****e	4
Tobias Sauter	g****1@m****e	4
tobias sauter	t****r@y****t	2
Franziska Temme	ft@F****x	2
tobias sauter	t****r@t****l	1
Niklas	N****r@u****t	1

Committer domains:

• geo.hu-berlin.de: 3
• fau.de: 2
• uibk.ac.at: 2
• franziskas-air.fritz.box: 1
• ydwli-e1-53-119.uibk.ac.at: 1
• meggie2.rrze.uni-erlangen.de: 1
• faustaff-010-020-005-142.pool.uni-erlangen.de: 1
• tobiass-mbp.home: 1
• live.de: 1
• meggie1.rrze.uni-erlangen.de: 1

---

Issue and Pull Request metadata

Last synced: 2 days ago

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/cryotools/cosipy

---

---

---

Package metadata

• Total packages: 1
• Total downloads:
  • pypi: 176 last-month
• Total dependent packages: 0
• Total dependent repositories: 0
• Total versions: 3
• Total maintainers: 1

---

Dependencies

Score: 12.590722613924418