Skip to content

CH-Aurora-2014 model#160

Merged
aburrell merged 4 commits into
developfrom
ch_aurora_2014_model
May 12, 2026
Merged

CH-Aurora-2014 model#160
aburrell merged 4 commits into
developfrom
ch_aurora_2014_model

Conversation

@aburrell
Copy link
Copy Markdown
Owner

@aburrell aburrell commented May 11, 2026

Description

Partially addresses #153 by adding the CHAMP FAC auroral boundary model.

Type of change

Please delete options that are not relevant.

  • New feature (non-breaking change which adds functionality)
  • This change requires a documentation update

How Has This Been Tested?

Created new unit tests. Also ran and compared output visually to Figure 2 of Xiong and Lühr (2014).

from ocbpy.boundaries import models
import numpy as np

mlt = np.arange(0.0, 24.0, 1.0)
ocb = models.ch_aurora_2014_boundary(mlt, em=0.3)

This will give you an OCB that matches the boundary shown in the northern hemisphere figure here.
ocbpy_ch_auroral_2014_em0p3_example

Test Configuration

  • Operating system: OS X Tahoe
  • Version number: Python 3.10
  • Any details about your local setup that are relevant: updated AACGMV2

Checklist:

  • Make sure you are merging into the develop (not main) branch
  • My commits are formatted appropriately (following the SciPy/NumPy style)
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • Add a note to Changelog.rst, summarising the changes
  • Add yourself to AUTHORS.rst and .zenodo.json

aburrell added 4 commits May 11, 2026 18:02
Added the CHAMP auroral boundary model.
Added unit tests for the CHAMP auroral boundary model.
Added citations and a description of the CHAMP auroral boundary model.
Added the inclusion of the new model to the changelog.
@aburrell aburrell added this to the v1.0.0 milestone May 11, 2026
@aburrell aburrell linked an issue May 11, 2026 that may be closed by this pull request
2 tasks
@aburrell aburrell merged commit e903b6d into develop May 12, 2026
59 of 95 checks passed
@aburrell aburrell deleted the ch_aurora_2014_model branch May 12, 2026 13:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add more boundary models

1 participant