Data

Tools

Indexes

Applications

Experiments

Open Source Science

discontinuitypy

Identify and analyze discontinuities in time series data.

https://github.com/beforerr/discontinuitypy

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
  • ✓
    DOI references
    Found 4 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (11.2%) to scientific vocabulary
Last synced: 7 months ago · JSON representation ·

Repository

Identify and analyze discontinuities in time series data.

Basic Info
Statistics
  • Stars: 1
  • Watchers: 1
  • Forks: 1
  • Open Issues: 0
  • Releases: 2
Created over 2 years ago · Last pushed 12 months ago
Metadata Files
Readme Citation

README.md

DiscontinuityPy

PyPI Pixi Badge pdm-managed DOI

User Guide

This package is designed to identify and analyze discontinuities in time series data.

  1. Finding the discontinuities, see this notebook
    • Corresponding to limited feature extraction / anomaly detection
  2. Calculating the properties of the discontinuities, see this notebook
    • One can use higher time resolution data

For how to use this project as a python library, please see this page.

See accompanying package Discontinuity.jl for Julia about data processing and visualization.

Installation

shell pip install discontinuitypy

Getting started

Import the package

python from discontinuitypy.utils.basic import * from discontinuitypy.core import *

Related projects and publications

Properties of Discontinuities

Notations:

  • $\vec{B}$ : Magnetic field in ANY coordinate system
  • $B$ : Magnetic field magnitude
  • $V$ : Ion velocity in ANY coordinate system, in units of $km/s$
  • $n$ : Plasma density, in units of $1/cm^3$

For the unit, by default we use

  • length : $km$
  • time : $s$
  • magnetic field : $nT$
  • current : $nA/m^2$

Outputs

For more derivable outputs, please see Discontinuity.jl

  • t_{us,ds} : moments of time corresponding to upstream and downstream boundaries of the current sheet

  • b_mag : mean of magnetic field magnitude across the discontinuity

  • $|Δ B|/B$ : Change in magnetic field magnitude over magnetic field magnitude (mean) db_over_b

    • see Fig.14 in Tsurutani and Smith (1979)

  • bn_over_b : $\bar{B}_N/\bar{B}$ : Normal component of magnetic field over magnetic field magnitude (mean)

  • $\vec{e}l, \vec{e}m, \vec{e}n$ : unit vector in the direction of the maxium, medium, minium variance magnetic field in _ANY coordinate system e_{max/med/min}{x,y,z}

  • $\vec{n}$ : normal of the discontinuity plane

  • $\vec{n}{\text{MVA}}$ : normal from minimum variance analysis (unit vector in the minium variance direction) `nmva = e_min`

  • $\vec{n}{\text{cross}}$ : cross product of the magnetic field vector $Bu$ upstream and the field vector $Bd$ downstream of the transition `ncross`

  • $V$ : Velocity vector in ANY coordinate system V

  • $Vl$ : Velocity component along the maximum variance direction `Vl`

  • $V{n,MVA}$ : Velocity component along the normal direction from minimum variance analysis `Vn_mva`

  • $V{n,cross}$ : Velocity component along the normal direction from cross product of upstream and downstream magnetic field `Vn_cross`

  • j0{_norm}: current density, in units of $nA/m^2$

Tsurutani, Bruce T., and Edward J. Smith. 1979. “Interplanetary Discontinuities: Temporal Variations and the Radial Gradient from 1 to 8.5 AU.” _Journal of Geophysical Research: Space Physics_ 84 (A6): 2773–87. .

Owner

  • Name: Beforerr
  • Login: Beforerr
  • Kind: user

Citation (CITATION.cff) 

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: "discontinuitypy: A python package for identifying and analyzing
  discontinuities for time series"
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Zijin
    family-names: Zhang
    orcid: "https://orcid.org/0000-0002-9968-067X"
identifiers:
  - type: doi
    value: 10.5281/zenodo.14868016
repository-code: "https://github.com/Beforerr/discontinuitypy"
url: "https://beforerr.github.io/discontinuitypy/"
license: MIT
date-released: "2025-02-13"
doi: 10.5281/zenodo.14868016

GitHub Events

Total
  • Create event: 6
  • Commit comment event: 2
  • Release event: 3
  • Issues event: 4
  • Push event: 47
  • Fork event: 1
Last Year
  • Create event: 6
  • Commit comment event: 2
  • Release event: 3
  • Issues event: 4
  • Push event: 47
  • Fork event: 1

Committers

Last synced: 11 months ago

All Time
  • Total Commits: 180
  • Total Committers: 1
  • Avg Commits per committer: 180.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 100
  • Committers: 1
  • Avg Commits per committer: 100.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Beforerr z****8@g****m 180

Issues and Pull Requests

Last synced: 8 months ago

All Time
  • Total issues: 2
  • Total pull requests: 0
  • Average time to close issues: about 13 hours
  • Average time to close pull requests: N/A
  • Total issue authors: 1
  • Total pull request authors: 0
  • Average comments per issue: 0.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 2
  • Pull requests: 0
  • Average time to close issues: about 13 hours
  • Average time to close pull requests: N/A
  • Issue authors: 1
  • Pull request authors: 0
  • Average comments per issue: 0.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • Beforerr (2)
Pull Request Authors
Top Labels
Issue Labels
enhancement (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 40 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 8
  • Total maintainers: 1
pypi.org: discontinuitypy

A python package for identifying and analyzing discontinuities for time series data.

  • Versions: 8
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 40 Last month
Rankings
Dependent packages count: 9.9%
Average: 37.6%
Dependent repos count: 65.4%
Maintainers (1)
Beforerr
Last synced: 8 months ago