volcano-data-deconvolution

Deconvolution applied to volcanic eruption time series

https://github.com/engeir/volcano-data-deconvolution

Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
    Links to: zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.3%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

Deconvolution applied to volcanic eruption time series

Basic Info
  • Host: GitHub
  • Owner: engeir
  • License: mit
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 465 KB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 21
Created over 2 years ago · Last pushed over 1 year ago
Metadata Files
Readme Changelog License Citation Zenodo

README.md

Accompanying code to 'Non-parametric estimation of temperature response to volcanic forcing'

DOI

Latest version: v2.0.1 <!-- x-release-please-version -->

[!WARNING]

This README reflects the changes made to the main branch. For the most up to date documentation about the version you are using, see the README at the relevant tag.

This repository contains analysis scripts that analyse output from volcanic eruption simulations in climate models, using a deconvolution algorithm commonly applied to time series with strong intermittency.

Install

To install the project you must clone the repository. If you have mise installed (recommended), this will install and set up the correct python version as a virtual environment into ./.venv/. If you do not wish to use mise, uv will by default also create a virtual environment with an available python runtime.

bash git clone git@github.com:engeir/volcano-data-deconvolution.git cd volcano-data-deconvolution || exit uv sync

[!NOTE]

The repository and project is named volcano-data-deconvolution, but the package name is vdd, just to make it shorter when importing.

After the uv sync command succeeds, you can check that everything is working by running

console $ uv run vdd Hello, this is vdd at version v2.0.1!

Usage

The main programs, i.e. those that create plots used in the accompanying paper, are run as entry point scripts of the package. A list of all entry points can be found by running the command uv run, or for a curated list of this project's entry points, run

bash uv run | grep vdd

All other useful scripts are located in the src/vdd/plotting/ directory. Any of those scripts can be run as

bash uv run python ./src/vdd/plotting/some_plotting_script.py

[!NOTE]

And again, if you use mise, you can do

bash mise run plot

and it will magically just work.

Owner

  • Name: Eirik Rolland Enger
  • Login: engeir
  • Kind: user
  • Location: Tromsø
  • Company: @NorskHelsenett

System engineer @NorskHelsenett. Previously, PhD candidate in the complex systems modelling group at UiT \\ eirikre.83 on @signalapp

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: Enger
  given-names: Eirik Rolland
  orcid: https://orcid.org/0000-0001-6709-8688
title: Accompanying code to 'Non-parametric estimation of temperature response to volcanic forcing'
version: volcano-data-deconvolution-v2.0.1  # x-release-please-version
# date-released: 2024-06-03
identifiers:
  - description: This is the collection of archived snapshots of all versions of My Research Software
    type: doi
    value: "10.5281/zenodo.11445641"
license: MIT
repository-code: "https://github.com/engeir/volcano-data-deconvolution"

GitHub Events

Total
  • Release event: 2
  • Issue comment event: 2
  • Member event: 1
  • Push event: 15
  • Pull request event: 3
  • Create event: 2
Last Year
  • Release event: 2
  • Issue comment event: 2
  • Member event: 1
  • Push event: 15
  • Pull request event: 3
  • Create event: 2

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 0
  • Total pull requests: 2
  • Average time to close issues: N/A
  • Average time to close pull requests: 29 days
  • Total issue authors: 0
  • Total pull request authors: 2
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 2
  • Average time to close issues: N/A
  • Average time to close pull requests: 29 days
  • Issue authors: 0
  • Pull request authors: 2
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
  • engeir (8)
  • han-eirik (1)
Top Labels
Issue Labels
Pull Request Labels
autorelease: pending (9)

Dependencies

.github/workflows/release.yml actions
  • googleapis/release-please-action v4 composite
pyproject.toml pypi
  • cartopy >=0.23.0
  • cmcrameri >=1.8
  • cosmoplots >=0.4.3
  • dask >=2024.2.0
  • fppanalysis >=0.1.4
  • h5netcdf >=1.3.0
  • matplotlib >=3.8.3
  • nc-time-axis >=1.4.1
  • numba >=0.59.1
  • numpy >=1.26.4
  • plastik >=0.6.2
  • pydantic >=2.6.4
  • pyqt5 >=5.15.10
  • sympy >=1.12
  • volcano-base >=2.0.2
  • xarray >=2024.2.0
  • xmovie >=0.3.1
.github/workflows/tests.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite