Added a boundary models

[aburrell]

Description

Fixes #124 by adding an empirical model for the OCB, and two different equatorward boundaries based off of northern hemisphere all-sky imager data. This is an older model, but creates a framework for adding newer auroral boundary models.

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?

Added unit tests, integration tests, and examples in the documentation.

import datetime as dt
import ocbpy

ocb = ocbpy.OCBoundary(instrument="model", hemisphere=1, stime=[dt.datetime(2000, 1, 1, i) for i in range(3)], rfunc=ocbpy.boundaries.models.starkov_auroral_boundary, rfunc_kwargs={"al": [ -10, -60, -100], "bnd": "ocb"})
print(ocb)

This yeilds:

OCBoundary
Source instrument: MODEL
Boundary reference latitude: 74.0 degrees

3 records from 2000-01-01 00:00:00 to 2000-01-01 02:00:00

YYYY-MM-DD HH:MM:SS Phi_Centre R_Centre R
-----------------------------------------------------------------------------
2000-01-01 00:00:00 0.00 0.00 0.00
2000-01-01 01:00:00 0.00 0.00 0.00
2000-01-01 02:00:00 0.00 0.00 0.00

Uses boundary function(s):
ocbpy.boundaries.models.starkov_auroral_boundary(**{'al': -10, 'bnd': 'ocb'})
ocbpy.boundaries.models.starkov_auroral_boundary(**{'al': -60, 'bnd': 'ocb'})
ocbpy.boundaries.models.starkov_auroral_boundary(**{'al': -100, 'bnd': 'ocb'})

Test Configuration

• Operating system: OS X Big Sur
• Version number: Python 3.10
• Any details about your local setup that are relevant: develop branch of pysat

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]

Failed tests are addressed in #152