Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[MNT]: Release PR for first major release of fitter #2

Draft
wants to merge 54 commits into
base: main
Choose a base branch
from
Draft

Conversation

asreimer
Copy link

@asreimer asreimer commented Nov 23, 2021

The first major version of the fitter and the first version to be publicly released.

Before merging:

  • add docs (readthedocs integration)
  • add notebooks (developer notes)
  • add .zenodo.json

… include covariant and contravariant kvectors.
[ENH]: Many large changes for modernization
@asreimer
Copy link
Author

.zenodo.json has been added.

Also added some basic readthedocs stuff (https://overspread.readthedocs.io/en/develop/). Need to flesh this documentation out more.

@asreimer
Copy link
Author

Dev notes for geomag.py are up now.

@asreimer
Copy link
Author

asreimer commented Nov 23, 2021

Remaining questions/todos:

  • version number format ok? Currently major.minor.yyyy.m.d. No, change to major.minor.patch (semantic versioning)
  • pip installable
  • how much documentation is needed for first release?

@asreimer
Copy link
Author

It is now pip installable.

@asreimer
Copy link
Author

asreimer commented Nov 24, 2021

Team Meeting Notes:

  • @asreimer finish minor changes to config files so the fitter is easy to run
  • @pmreyes2 verification process needed, compute statistics of previous fitted files vs. new fitted files. Needs to be a representative sample of AMISR experiments.
  • @ljlamarche add git commit to fitted files

@asreimer
Copy link
Author

As of this writing, you need to use this specific commit on apexpy to run the fitter:

pip install git+https://github.com/aburrell/apexpy.git@4eaeb98509214a8942574775c8dad7f51d21007e

If you do not, the UT of magnetic midnight variable will not be set correctly. This needs to be done until aburrell/apexpy#82 is merged and a new release of apexpy that includes this fix is done.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant