Merge pull request #64 from CosmicStudioSoftware/igrf14

Updated package to use IGRF14

Author: rstoneback

.github/workflows/docs.yml

@@ -29,11 +29,6 @@ jobs:
         pip install -r test_requirements.txt
         pip install -r requirements.txt
 
-    - name: Set up pysat
-      run: |
-        mkdir pysatData
-        python -c "import pysat; pysat.params['data_dirs'] = 'pysatData'"
-
     - name: Check documentation build
       run: sphinx-build -E -b html docs dist/docs
 

.github/workflows/main.yml

@@ -16,7 +16,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: ["ubuntu-latest", "windows-latest"]
+        os: ["ubuntu-latest"]
         python-version: ["3.9", "3.10", "3.11", "3.12"]
         numpy_ver: ["latest"]
         include:
@@ -109,18 +109,23 @@ jobs:
       if: ${{ matrix.os != 'windows-latest' }}
       run: |
         rm -rf ./OMMBV 
-        cd ..
-        coverage run -m pytest
+        mkdir new_dir
+        cd new_dir
+
+        coverage run -m pytest ../
         coverage report
         coverage xml
-        mv coverage.xml ./OMMBV/.
+        ls
+        cp coverage.xml ../coverage.xml
+        cat coverage.xml
 
     - name: Run unit and integration tests on Windows
       if: ${{ matrix.os == 'windows-latest' }}
       run: |
         rm ./OMMBV -r -force
         cd ..
-        coverage run -m pytest
+        pytest ./OMMBV/tests -v --cov
+        
         coverage report
         coverage xml
         mv coverage.xml .\OMMBV\.
@@ -129,7 +134,7 @@ jobs:
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         COVERALLS_PARALLEL: true
-      run: coveralls --rcfile=setup.cfg --service=github
+      run: coveralls --service=github --verbose
 
   finish:
     name: Finish Coverage Analysis
@@ -141,4 +146,4 @@ jobs:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       run: |
         pip install --upgrade coveralls
-        coveralls --service=github --finish
+        coveralls --service=github --finish --verbose

.readthedocs.yml

@@ -5,6 +5,12 @@
 # Required
 version: 2
 
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.10"
+
+
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
   configuration: docs/conf.py
@@ -20,7 +26,6 @@ formats:
 # Optionally set the version of Python and requirements
 # required to build your docs
 python:
-  version: 3.7
   install:
     - requirements: docs/requirements.txt
 

CHANGELOG.md

@@ -2,11 +2,12 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-## [1.0.2] - ?????
+## [1.1.0] - ?????
 - Switched away from distutils to Meson for build system
 - Updated coupling to coveralls
 - Updated package version for security issue in sphinx
-- Added online unit testing for Linux/MacOS/Windows
+- Added online unit testing for Linux and MacOS
+- Updated to IGRF14
 
 ## [1.0.1] - 2022-01-04
 - Added pyproject.toml to support systems without numpy.

CODE_OF_CONDUCT.md

@@ -4,10 +4,10 @@
 
 In the interest of fostering an open and welcoming environment, we as
 contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, sex characteristics, gender identity and expression,
-level of experience, education, socio-economic status, nationality, personal
-appearance, race, religion, or sexual identity and orientation.
+our community a harassment-free experience for everyone, regardless of age,
+body size, disability, ethnicity, gender identity and expression, level of
+experience, nationality, personal appearance, race, religion, or sexual
+identity and orientation.
 
 ## Our Standards
 
@@ -23,13 +23,13 @@ include:
 Examples of unacceptable behavior by participants include:
 
 * The use of sexualized language or imagery and unwelcome sexual attention or
- advances
+  advances
 * Trolling, insulting/derogatory comments, and personal or political attacks
 * Public or private harassment
 * Publishing others' private information, such as a physical or electronic
- address, without explicit permission
+  address, without explicit permission
 * Other conduct which could reasonably be considered inappropriate in a
- professional setting
+  professional setting
 
 ## Our Responsibilities
 
@@ -48,29 +48,35 @@ threatening, offensive, or harmful.
 This Code of Conduct applies both within project spaces and in public spaces
 when an individual is representing the project or its community. Examples of
 representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
+address, posting via an official social media account, or acting as an
+appointed representative at an online or offline event. Representation of a
+project may be further defined and clarified by project maintainers.
 
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at [email protected]. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
+reported by contacting the project team at [email protected]. The
+pysat project team will review and investigate all complaints, and will respond
+in a way that it deems appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an
+incident. Further details of specific enforcement policies may be posted
+separately.
 
 Project maintainers who do not follow or enforce the Code of Conduct in good
 faith may face temporary or permanent repercussions as determined by other
 members of the project's leadership.
 
 ## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.4, available at
+[https://contributor-covenant.org/version/1/4][version]
 
-[homepage]: https://www.contributor-covenant.org
+## FAQ
 
 For answers to common questions about this code of conduct, see
-https://www.contributor-covenant.org/faq
+[https://www.contributor-covenant.org/faq][faq]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/
+[faq]: https://www.contributor-covenant.org/faq

CONTRIBUTING.md

@@ -1,87 +1,173 @@
 Contributing
 ============
 
-Bug reports, feature suggestions and other contributions are greatly
-appreciated!  Pysat is a community-driven project and welcomes both feedback and
-contributions.
+Bug reports, feature suggestions, and other contributions are greatly
+appreciated!  
 
 Short version
-=============
+-------------
+
+* Submit bug reports, feature requests, and questions at
+  [GitHub](https://github.com/CosmicStudioSoftware/OMMBV/issues)
 
-* Submit bug reports and feature requests at `GitHub <https://github.com/rstoneback/OMMBV/issues>`_
 * Make pull requests to the ``develop`` branch
 
+Issues
+------
+
+Bug reports, questions, and feature requests should all be made as GitHub
+Issues.  Templates are provided for each type of issue, to help you include
+all the necessary information.
+
+Questions
+^^^^^^^^^
+
+Not sure how something works?  Ask away!  The more information you provide, the
+easier the question will be to answer. 
+
 Bug reports
-===========
+^^^^^^^^^^^
 
-When `reporting a bug <https://github.com/rstoneback/OMMBV/issues>`_ please
+When [reporting a bug](https://github.com/CosmicStudioSoftware/OMMBV/issues) please
 include:
 
 * Your operating system name and version
+
 * Any details about your local setup that might be helpful in troubleshooting
+
 * Detailed steps to reproduce the bug
 
 Feature requests and feedback
-=============================
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-The best way to send feedback is to file an issue at
-`GitHub <https://github.com/rstoneback/OMMBV/issues>`_.
+The best way to send feedback is to file an
+[issue](https://github.com/CosmicStudioSoftware/OMMBV/issues).
 
-If you are proposing a feature:
+If you are proposing a new feature or a change in something that already exists:
 
 * Explain in detail how it would work.
+
 * Keep the scope as narrow as possible, to make it easier to implement.
+
 * Remember that this is a volunteer-driven project, and that code contributions
   are welcome :)
 
 Development
-===========
+-----------
+
+To set up `OMMBV` for local development:
 
-To set up `pysat` for local development:
+1. [Fork OMMBV on GitHub](https://github.com/CosmicStudioSoftware/OMMBV/fork).
 
-1. `Fork pysat on GitHub <https://github.com/rstoneback/OMMBV/fork>`_.
-2. Clone your fork locally::
+2. Clone your fork locally:
 
-    git clone [email protected]:your_name_here/pysatMagVect.git
+  ```
+    git clone [email protected]:your_name_here/OMMBV.git
+  ```
 
-3. Create a branch for local development::
+3. Create a branch for local development:
 
+  ```
     git checkout -b name-of-your-bugfix-or-feature
+  ```
+
+   Now you can make your changes locally.
+
 
-   Now you can make your changes locally. Tests should be added to the
-   appropriately named file in ``OMMBV/tests``. 
-    
 4. When you're done making changes, run all the checks to ensure that nothing
-   is broken on your local system::
-   
-    nosetests -vs pysatMagVect
+   is broken on your local system, as well as check for flake8 compliance:
+
+   ```
+    pytest
+   ```
+
+5. You should also check for flake8 style compliance:
+
+   ```
+   flake8 . --count --select=D,E,F,H,W --show-source --statistics
+   ```
 
-5. Update/add documentation (in ``docs``), if relevant
+   Note that pysat uses the `flake-docstrings` and `hacking` packages to ensure
+   standards in docstring formatting.
 
-5. Commit your changes and push your branch to GitHub::
+6. Update/add documentation (in ``docs``).  Even if you don't think it's
+   relevant, check to see if any existing examples have changed.
 
-    git add .
-    git commit -m "Brief description of your changes"
-    git push origin name-of-your-bugfix-or-feature
+7. Add your name to the .zenodo.json file as an author
+
+8. Commit your changes:
+   ```
+   git add .
+   git commit -m "AAA: Brief description of your changes"
+   ```
+   Where AAA is a standard shorthand for the type of change (e.g., BUG or DOC).
+   `pysat` follows the [numpy development workflow](https://numpy.org/doc/stable/dev/development_workflow.html),
+   see the discussion there for a full list of this shorthand notation.  
+
+9. Once you are happy with the local changes, push to GitHub:
+   ```
+   git push origin name-of-your-bugfix-or-feature
+   ```
+   Note that each push will trigger the Continuous Integration workflow.
+
+10. Submit a pull request through the GitHub website. Pull requests should be
+    made to the ``develop`` branch.  Note that automated tests will be run on
+    GitHub Actions, but these must be initialized by a member of the pysat team
+    for first time contributors.
 
-6. Submit a pull request through the GitHub website. Pull requests should be
-   made to the ``develop`` branch.
 
 Pull Request Guidelines
 -----------------------
 
 If you need some code review or feedback while you're developing the code, just
-make a pull request.
+make a pull request. Pull requests should be made to the ``develop`` branch.
 
 For merging, you should:
 
 1. Include an example for use
 2. Add a note to ``CHANGELOG.md`` about the changes
-3. Ensure that all checks passed (current checks include Scrutinizer, Travis-CI,
-   and Coveralls) [1]_
-
-.. [1] If you don't have all the necessary Python versions available locally or
-       have trouble building all the testing environments, you can rely on
-       Travis to run the tests for each change you add in the pull request.
-       Because testing here will delay tests by other developers, please ensure
-       that the code passes all tests on your local system first.
+3. Update the author list in ``zenodo.json``, if applicable
+4. Ensure that all checks passed (current checks include GitHub Actions,
+   Coveralls and ReadTheDocs)
+
+If you don't have all the necessary Python versions available locally or have
+trouble building all the testing environments, you can rely on GitHub Actions to
+run the tests for each change you add in the pull request. Because testing here
+will delay tests by other developers, please ensure that the code passes all
+tests on your local system first.
+
+
+Project Style Guidelines
+------------------------
+
+In general, OMMBV follows PEP8 and numpydoc guidelines.  Pytest runs the unit
+and integration tests, flake8 checks for style, and sphinx-build performs
+documentation tests.  However, there are certain additional style elements that
+have been adopted to ensure the project maintains a consistent coding style.
+These include:
+
+* Line breaks should occur before a binary operator (ignoring flake8 W503)
+* Combine long strings using `join`
+* Preferably break long lines on open parentheses rather than using `\`
+* Use no more than 80 characters per line
+* Several dependent packages have common nicknames, including:
+  * `import datetime as dt`
+  * `import numpy as np`
+  * `import pandas as pds`
+  * `import xarray as xr`
+* When incrementing a timestamp, use `dt.timedelta` instead of `pds.DateOffset`
+  when possible to reduce program runtime
+* All classes should have `__repr__` and `__str__` functions
+* Docstrings use `Note` instead of `Notes`
+* Try to avoid creating a try/except statement where except passes
+* Use setup_method (or setup_class) and teardown_method (or teardown_class) in
+  test classes
+* Use pytest parametrize in test classes when appropriate
+* Provide testing class methods with informative failure statements and
+  descriptive, one-line docstrings
+* Block and inline comments should use proper English grammar and punctuation
+  with the exception of single sentences in a block, which may then omit the
+  final period
+* When casting is necessary, use `np.int64` and `np.float64` to ensure operating
+  system agnosticism
+

OMMBV/__init__.py

@@ -24,3 +24,5 @@
 
 __all__ = ['igrf', 'fortran_coords', 'sources', 'satellite',
            'trace', 'trans', 'utils', 'vector', 'heritage']
+
+print("OMMBV brought to you by Cosmic Studio.")