Skip to content

Troyer model - #165

Merged
aburrell merged 12 commits into
developfrom
troyer_model_plus
Sep 24, 2026
Merged

aburrell merged 12 commits into
developfrom
troyer_model_plus

Conversation

@aburrell

@aburrell aburrell commented Sep 21, 2026 •

Copy link
Copy Markdown
Owner

Description

Fixes #153 by adding the Troyer model. Also adds AMERE files to the .gitignore.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • This change requires a documentation update

How Has This Been Tested?

Added unit tests.

Test Configuration

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

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 assert that I have not used AI in the development of this pull request
  • 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

Add the AMPERE Milan and formatted ocbpy files to the .gitignore.
Added the new optional dependency to the README.
Added documentation for the Troyer model.
Added the Troyer model for the EAB.
Updated the model description to speak to the probabilistic option that is not implemented here.
Added unit tests for the Troyer model.
Added a note about the percentile to the Troyer docstring.
Added the Troyer model update to the changelog.
@aburrell aburrell added this to the v1.0.0 milestone Sep 21, 2026
@aburrell aburrell linked an issue Sep 21, 2026 that may be closed by this pull request
2 tasks done
Comment thread docs/citing.rst Outdated
Comment thread ocbpy/boundaries/models.py Outdated
Comment thread .gitignore Outdated
Comment thread ocbpy/boundaries/models.py
Fixed typos in the references and removed extra whitespace.

Co-authored-by: Angeline Burrell <aburrell@users.noreply.github.com>
@aburrell

Copy link
Copy Markdown
Owner Author

@rileytroyer let me know what you think!

@coveralls

coveralls commented Sep 21, 2026 •

Copy link
Copy Markdown

Coverage Status

coverage: 99.497% (+0.02%) from 99.481% — troyer_model_plus into develop

Ensure that a float input into the Gussenhoven model leads to a float output.
Added a test for the float input/output for the Gussenhoven model.
Comment thread ocbpy/boundaries/models.py
return rad


def troyer_equatorward_auroral_boundary(mlt, hp=0):

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For future builds, assuming availability, would you envision including a argument to specify the specific percentile, or would you have that as a separate function?

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I'd add a kwarg that defaults to 50 or .5 (depending on how we formulate it) for the fully probabilistic code. Maybe even allow array-like input/output for less computations and an ensemble output? I look forward to upgrading it in the future!

Fixed the casting of float output for the Gussenhoven model.
@aburrell
aburrell merged commit efcf60c into develop Sep 24, 2026
100 checks passed
@aburrell
aburrell deleted the troyer_model_plus branch September 24, 2026 16:07
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

3 participants