Merge pull request #13 from pysat/Madrigal_Updates

Madrigal updates

.github/pull_request_template.md

@@ -24,7 +24,10 @@ or test files is frequently very useful.  Please also list any relevant details
 for your test configuration.
 
 - Test A
-- Test B
+
+```
+Test B
+```
 
 ## Test Configuration
 * Operating system: Hal
@@ -36,6 +39,7 @@ for your test configuration.
 - [ ] Make sure you are merging into the ``develop`` (not ``main``) branch
 - [ ] My code follows the style guidelines of this project
 - [ ] I have performed a self-review of my own code
+- [ ] I have linted the files updated in this pull request
 - [ ] 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

.github/workflows/docs.yml

@@ -1,5 +1,6 @@
-# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
-# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+# This workflow will install Python dependencies, run tests and lint with a
+# variety of Python versions. For more information see:
+# https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
 
 name: Documentation Check
 

.github/workflows/main.yml

@@ -1,5 +1,6 @@
-# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
-# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+# This workflow will install Python dependencies, run tests and lint with a
+# variety of Python versions. For more information see:
+# https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
 
 name: Pytest with Flake8
 

.github/workflows/pip_rc_install.yml

@@ -1,6 +1,7 @@
-# This workflow will install Python dependencies and the latest RC of pysatNASA from test pypi.
-# This test should be manually run before an RC is officially approved and versioned.
-# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+# This workflow will install Python dependencies and the latest RC of
+# PROJECTNAME from test pypi. This test should be manually run before an RC is
+# officially approved and versioned. For more information see:
+# https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
 
 name: Test install of latest RC from pip
 

.github/workflows/pysat_rc.yml

@@ -1,5 +1,6 @@
-# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
-# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+# This workflow will install Python dependencies, run tests and lint with a
+# variety of Python versions. For more information see:
+# https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
 
 name: Test with latest pysat RC
 
@@ -11,7 +12,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest, macos-latest, windows-latest]
+        os: ["ubuntu-latest", "macos-latest", "windows-latest"]
         python-version: ["3.10"]
 
     name: Python ${{ matrix.python-version }} on ${{ matrix.os }}

CODE_OF_CONDUCT.md

@@ -55,13 +55,12 @@ 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]
-(PACKAGENAME SPECIFIC EMAIL MAY BE USED HERE). The
-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.
+reported by contacting the project team at [email protected]. The
+(PACKAGENAME SPECIFIC EMAIL MAY BE USED HERE) 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

CONTRIBUTING.md

@@ -2,8 +2,8 @@ Contributing
 ============
 
 Bug reports, feature suggestions, and other contributions are greatly
-appreciated!  pysat is a community-driven project and welcomes both feedback and
-contributions.
+appreciated!  pysat and (PROJECT NAME) are community-driven projects that
+welcome both feedback and contributions.
 
 Come join us on Slack! An invitation to the pysat workspace is available
 in the 'About' section of the
@@ -13,13 +13,27 @@ are generally held fortnightly.
 Short version
 -------------
 
-* Submit bug reports and feature requests at
+* Submit bug reports, feature requests, and questions at
   [GitHub](https://github.com/pysat/PACKAGENAME/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.  You can also interact with the pysat
+developers on our [slack channel](https://pysat.slack.com).
+
 Bug reports
------------
+^^^^^^^^^^^
 
 When [reporting a bug](https://github.com/pysat/PACKAGENAME/issues) please
 include:
@@ -31,12 +45,12 @@ include:
 * 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/pysat/PACKAGENAME/issues).
+The best way to send feedback is to file an
+[issue](https://github.com/pysat/PACKAGENAME/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.
 
@@ -94,8 +108,8 @@ To set up `PACKAGENAME` for local development:
    Note that pysat uses the `flake-docstrings` and `hacking` packages to ensure
    standards in docstring formatting.
 
-
-6. Update/add documentation (in ``docs``), if relevant
+6. Update/add documentation (in ``docs``).  Even if you don't think it's
+   relevant, check to see if any existing examples have changed.
 
 7. Add your name to the .zenodo.json file as an author
 
@@ -133,11 +147,11 @@ For merging, you should:
 4. Ensure that all checks passed (current checks include Github Actions and
    Coveralls)
 
-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.
+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
@@ -167,7 +181,8 @@ These include:
 * 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 setup_method (or setup_class) and teardown_method (or teardown_class) in
+  test classes
 * Use pytest parametrize in test classes when appropriate
 * Use pysat testing utilities when appropriate
 * Provide testing class methods with informative failure statements and

PACKAGENAME/__init__.py

@@ -0,0 +1,14 @@
+"""Core library for PACKAGENAME.
+
+DESCRIPTION.
+
+"""
+
+try:
+    from importlib import metadata
+except ImportError:
+    import importlib_metadata as metadata
+
+from PACKAGENAME import instruments  # noqa F401
+
+__version__ = metadata.version('PACKAGENAME')

README.md

@@ -73,5 +73,5 @@ pysat.utils.registry.register('PACKAGENAME.instruments.EX_INST')
 inst = pysat.Instrument('EX', 'INST')
 ```
 
-The package include analysis tools as well.  Detailed examples are in the
-documentation (LINK TO READTHEDOCS).
+The package also includes analysis tools.  Detailed examples are in the
+[documentation](LINK TO READTHEDOCS).

docs/conf.py

@@ -22,6 +22,7 @@
 import os
 from pyproject_parser import PyProject
 import sys
+
 sys.path.insert(0, os.path.abspath('..'))
 
 # -- Project information - Replace PACKAGENAME, ETC with appropriate package information ---
@@ -111,8 +112,7 @@
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
-#
-# html_theme_options = {}
+html_theme_options = {'logo_only': True}
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

pyproject.toml

@@ -3,7 +3,7 @@ requires = ["setuptools >= 38.6", "pip >= 10"]
 build-backend = "setuptools.build_meta"
 
 [project]
-name = PACKAGENAME
+name = "PACKAGENAME"
 version = "0.0.1"
 description = 'pysat support for DATA OR ANALYSIS'
 readme = "README.md"