Release Candidate 0.3.0

[jklenzing]

Description

Alpha release fully compatible with pysat 3.0.0+.

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?

This has been tested by running examples and unit tests locally

Test Configuration

• Operating system: OS X Mojave
• Version number: Python 3.7
• Any details about your local setup that are relevant: tested with pysat 3.0.0 and develop

Checklist:

• Update the version number
• Verify and update Zenodo information in .zeondo.json
• doc tests pass locally
• activate this branch on readthedocs (https://pysatmissions.readthedocs.io/en/rc_0_3_0)
• Upload the test distribution to the testPyPi server: https://test.pypi.org/project/pysatMissions/0.3.0a0/
• Contacted developers and users about the future release
• Performed integration tests with downstream packages (include list of these packages) - na
• Create a wiki page with the release text (https://github.com/pysat/pysatMissions/wiki/v0.3.0)
• After approval, confirm all changes from the RC pull are listed in the wiki release text.
• 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.md, summarizing the changes

[jklenzing]

Readthedocs is having trouble loading the autodoc info: https://pysatmissions.readthedocs.io/en/rc_0_3_0/supported_instruments.html

[aburrell]

Looks like there are some important warnings raised in the RTD log. For example:

/home/docs/checkouts/readthedocs.org/user_builds/pysatmissions/checkouts/rc_0_3_0/docs/installation.rst:61: WARNING: Explicit markup ends without a blank line; unexpected unindent.
WARNING: autodoc: failed to import module 'instruments.missions_ephem' from module 'pysatMissions'; the following exception was raised:
No module named 'numpy'
WARNING: autodoc: failed to import module 'instruments.missions_sgp4' from module 'pysatMissions'; the following exception was raised:
No module named 'numpy'

More here: https://readthedocs.org/api/v2/build/16783478.txt

[JonathonMSmith]

Local build and tests work on my end

[rstoneback]

Not the right place, closest I could get.

the methods area doesn't have an API in the docs, pysatMissions.methods.magcoords and pysatMissions.methods.satellite. Similarly, pysatMissions.instruments.methods.orbits

[rstoneback]

Not the right place.

In tutorials, you currently have

import pysat
from pysatMissions.methods import magcoord

inst = pysat.Instrument(platform='pysat', name='testing')
inst.custom_attach(magcoord.add_aacgm_coordinates,
                   kwargs={'glat_label': 'latitude',
                           'glong_label': 'longitude',
                           'alt_label': 'altitude'})

recommend using the existing sgp4 instrument defined above and switching to

import pysat
from pysatMissions.methods import magcoord

sgp4 = pysat.Instrument(inst_module=missions_sgp4, num_samples=3600)
sgp4.custom_attach(magcoord.add_aacgm_coordinates,
                   kwargs={'glat_label': 'latitude',
                           'glong_label': 'longitude',
                           'alt_label': 'geod_altitude'})
sgp4.load(2019, 1)

No warnings are raised about unable to perform conversion and shows how to apply to the orbit simulator.

[jklenzing]

@rstoneback, I've updated the docs accordingly and added a date. If it looks good to you, I can finalize the release this afternoon.

[rstoneback]

Thanks @jklenzing!