refactor: switch input methods to classmethods

.github/workflows/python-request.yml

@@ -44,6 +44,7 @@ jobs:
           flake8
           pytest
           pytest-cov
+          pytest-xdist
     - name: Lint with flake8
       run: |
         # stop the build if there are Python syntax errors or undefined names
@@ -53,7 +54,7 @@ jobs:
     - name: Test with pytest
       run: |
         pip install --no-deps .
-        pytest --verbose --capture=no --cov=./ --cov-report=xml \
+        pytest -n 0 --cov=./ --cov-report=xml \
             --username=${{ secrets.EARTHDATA_USERNAME }} \
             --password=${{ secrets.EARTHDATA_PASSWORD }}
     - name: Archive code coverage results

CODE_OF_CONDUCT.rst → CODE_OF_CONDUCT.md

@@ -1,9 +1,6 @@
-===============
-Code of Conduct
-===============
+# Code of Conduct
 
-Our Pledge
-##########
+## Our Pledge
 
 We as members, contributors, and leaders pledge to make participation in our
 community a harassment-free experience for everyone, regardless of age, body
@@ -15,39 +12,37 @@ and orientation.
 We pledge to act and interact in ways that contribute to an open, welcoming,
 diverse, inclusive, and healthy community.
 
-Our Standards
-#############
+## Our Standards
 
 Examples of behavior that contributes to a positive environment for our
 community include:
 
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
   and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the
+- Focusing on what is best not just for us as individuals, but for the
   overall community
 
 Examples of unacceptable behavior include:
 
-* Offensive comments related to gender, gender identity and expression, sexual orientation,
+- Offensive comments related to gender, gender identity and expression, sexual orientation,
   disability, mental illness, physical appearance, body size, race, or religion
-* Deliberate misgendering or use of "dead" or rejected names
-* The use of sexualized language or imagery, and sexual attention or
+- Deliberate misgendering or use of "dead" or rejected names
+- The use of sexualized language or imagery, and sexual attention or
   advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Incitement or threats of violence towards any individual,
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Incitement or threats of violence towards any individual,
   including encouraging a person to commit suicide or to engage in self-harm
-* Publishing others' private information, such as a physical or email
+- Publishing others' private information, such as a physical or email
   address, without their explicit permission
-* Advocating for, or encouraging, any of the above behavior
-* Other conduct which could reasonably be considered inappropriate in a
+- Advocating for, or encouraging, any of the above behavior
+- Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
-Enforcement Responsibilities
-############################
+## Enforcement Responsibilities
 
 Community leaders are responsible for clarifying and enforcing our standards of
 acceptable behavior and will take appropriate and fair corrective action in
@@ -59,25 +54,21 @@ comments, commits, code, wiki edits, issues, and other contributions that are
 not aligned to this Code of Conduct, and will communicate reasons for moderation
 decisions when appropriate.
 
-Enforcement
-###########
+## Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at
-`@tsutterley <mailto: tsutterl@uw.edu>`_.
+Instances of abusive, harassing, or otherwise unacceptable behavior can be
+reported to the organizational leaders responsible for enforcement.
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the
 reporter of any incident.
 
-Enforcement Guidelines
-######################
+## Enforcement Guidelines
 
 Community leaders will follow these Community Impact Guidelines in determining
 the consequences for any action they deem in violation of this Code of Conduct:
 
-1. Correction
--------------
+### 1. Correction
 
 **Community Impact**: Use of inappropriate language or other behavior deemed
 unprofessional or unwelcome in the community.
@@ -86,8 +77,7 @@ unprofessional or unwelcome in the community.
 clarity around the nature of the violation and an explanation of why the
 behavior was inappropriate. A public apology may be requested.
 
-2. Warning
-----------
+### 2. Warning
 
 **Community Impact**: A violation through a single incident or series
 of actions.
@@ -99,8 +89,7 @@ includes avoiding interactions in community spaces as well as external channels
 like social media. Violating these terms may lead to a temporary or
 permanent ban.
 
-3. Temporary Ban
-----------------
+### 3. Temporary Ban
 
 **Community Impact**: A serious violation of community standards, including
 sustained inappropriate behavior.
@@ -111,26 +100,24 @@ private interaction with the people involved, including unsolicited interaction
 with those enforcing the Code of Conduct, is allowed during this period.
 Violating these terms may lead to a permanent ban.
 
-4. Permanent Ban
-----------------
+### 4. Permanent Ban
 
 **Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior,  harassment of an
+standards, including sustained inappropriate behavior, harassment of an
 individual, or aggression toward or disparagement of classes of individuals.
 
 **Consequence**: A permanent ban from any sort of public interaction within
 the community.
 
-Attribution
-###########
+## Attribution
 
-This code of conduct is adapted from the `Contributor Covenant <https://www.contributor-covenant.org/>`_
-`Code of Conduct <https://www.contributor-covenant.org/version/2/1/code_of_conduct.html>`_ and
-the `Geek Feminism <http://geekfeminism.wikia.com>`_
-`Community Anti-Harassment Policy <http://geekfeminism.wikia.com/wiki/Community_anti-harassment/Policy>`_.
+This code of conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/)
+[Code of Conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html) and
+the [Geek Feminism](http://geekfeminism.wikia.com)
+[Community Anti-Harassment Policy](http://geekfeminism.wikia.com/wiki/Community_anti-harassment/Policy).
 
-Community Impact Guidelines were inspired by `Mozilla's code of conduct
-enforcement ladder <https://github.com/mozilla/diversity>`_.
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
 
 We have adapted these documents for our own use under the terms of the
-`Creative Commons Attribution License <https://creativecommons.org/licenses/by/4.0/>`_.
+[Creative Commons Attribution License](https://creativecommons.org/licenses/by/4.0/).

CONTRIBUTORS.md

@@ -0,0 +1,6 @@
+- [Karen Alley (University of Manitoba)](https://umanitoba.ca/environment-earth-resources/dr-karen-alley-profile-page)
+- [Kelly Brunt (NASA Goddard Space Flight Center)](https://science.gsfc.nasa.gov/sed/bio/kelly.m.brunt)
+- [Susan Howard (Earth & Space Research)](https://www.esr.org/staff/susan-l-howard/)
+- [Laurie Padman (Earth & Space Research)](https://www.esr.org/staff/laurence-padman/)
+- [Matt Siegfried (Colorado School of Mines)](https://geophysics.mines.edu/project/siegfried-matthew/)
+- [Tyler Sutterley (University of Washington)](http://psc.apl.uw.edu/people/investigators/tyler-sutterley/)

README.md

@@ -0,0 +1,102 @@
+---
+substitutions:
+  Documentation Status: |-
+    ```{image} https://readthedocs.org/projects/timescale/badge/?version=latest
+    :target: https://timescale.readthedocs.io/en/latest/?badge=latest
+    ```
+  License: |-
+    ```{image} https://img.shields.io/github/license/pyTMD/timescale
+    :target: https://github.com/pyTMD/timescale/blob/main/LICENSE
+    ```
+  PyPI: |-
+    ```{image} https://img.shields.io/pypi/v/timescale.svg
+    :target: https://pypi.python.org/pypi/timescale/
+    ```
+  commits-since: |-
+    ```{image} https://img.shields.io/github/commits-since/pyTMD/timescale/latest
+    :target: https://github.com/pyTMD/timescale/releases/latest
+    ```
+  conda-forge: |-
+    ```{image} https://img.shields.io/conda/vn/conda-forge/timescale
+    :target: https://anaconda.org/conda-forge/timescale
+    ```
+  zenodo: |-
+    ```{image} https://zenodo.org/badge/681330279.svg
+    :target: https://zenodo.org/badge/latestdoi/681330279
+    ```
+---
+
+# timescale
+
+{{ License }}
+{{ Documentation Status }}
+{{ PyPI }}
+{{ conda-forge }}
+{{ commits-since }}
+{{ zenodo }}
+
+Python tools for time and astronomical calculations
+
+For more information: see the documentation at [timescale.readthedocs.io](https://timescale.readthedocs.io/)
+
+## Installation
+
+From PyPI:
+
+```bash
+python3 -m pip install timescale
+```
+
+Using `conda` or `mamba` from conda-forge:
+
+```bash
+conda install -c conda-forge timescale
+```
+
+```bash
+mamba install -c conda-forge timescale
+```
+
+Development version from GitHub:
+
+```bash
+python3 -m pip install git+https://github.com/pyTMD/timescale.git
+```
+
+## Dependencies
+
+- [dateutil: powerful extensions to datetime](https://dateutil.readthedocs.io/en/stable/)
+- [lxml: processing XML and HTML in Python](https://pypi.python.org/pypi/lxml)
+- [numpy: Scientific Computing Tools For Python](https://www.numpy.org)
+- [scipy: Scientific Tools for Python](https://www.scipy.org/)
+
+## References
+
+> T. C. Sutterley, T. Markus, T. A. Neumann, M. R. van den Broeke, J. M. van Wessem, and S. R. M. Ligtenberg,
+> "Antarctic ice shelf thickness change from multimission lidar mapping", *The Cryosphere*,
+> 13, 1801-1817, (2019). [doi: 10.5194/tc-13-1801-2019](https://doi.org/10.5194/tc-13-1801-2019)
+
+## Download
+
+The program homepage is:
+
+<https://github.com/pyTMD/timescale>
+
+A zip archive of the latest version is available directly at:
+
+<https://github.com/pyTMD/timescale/archive/main.zip>
+
+## Disclaimer
+
+This package includes software developed at NASA Goddard Space Flight Center (GSFC) and the University of Washington Applied Physics Laboratory (UW-APL).
+It is not sponsored or maintained by the Universities Space Research Association (USRA), AVISO or NASA.
+The software is provided here for your convenience but *with no guarantees whatsoever*.
+
+## Contributing
+
+This project contains work and contributions from the [scientific community](./CONTRIBUTORS.rst).
+If you would like to contribute to the project, please have a look at the [open issues](https://github.com/pyTMD/timescale/issues) and [discussions board](https://github.com/pyTMD/timescale/discussions).
+
+## License
+
+The content of this project is licensed under the [Creative Commons Attribution 4.0 Attribution license](https://creativecommons.org/licenses/by/4.0/) and the source code is licensed under the [MIT license](LICENSE).

doc/source/getting_started/Code-of-Conduct.rst

@@ -1 +1,2 @@
-.. include:: ../../../CODE_OF_CONDUCT.rst
+.. include:: ../../../CODE_OF_CONDUCT.md
+    :parser: commonmark

doc/source/getting_started/Contributing.rst

@@ -4,12 +4,14 @@ Contribution Guidelines
 
 ``timescale`` is an open source project.
 We welcome any help in maintaining and developing the software and documentation.
-Anyone at any career stage and with any level of coding experience can contribute towards the development of ``timescale``.
+Anyone at *any career stage and with any level of coding experience* can contribute towards the development of ``timescale``.
 Please read our `code of conduct <./Code-of-Conduct.html>`_ before contributing to ``timescale`` development.
 You will be recognized for your work by being listed as one of the `project contributors <../project/Contributors.html>`_.
 
-If you have found a problem in ``timescale``, or you would like to suggest an improvement or modification,
-please submit a `GitHub issue <https://github.com/pyTMD/timescale/issues>`_ and we will get back to you.
+.. note::
+
+    If you have found a problem in ``timescale``, or you would like to suggest an improvement or modification,
+    please submit a `GitHub issue <https://github.com/pyTMD/timescale/issues>`_ and we will get back to you.
 
 Ways to Contribute
 ------------------
@@ -34,10 +36,10 @@ If not, *please* submit a new issue so that we are made aware of the problem.
 Please provide as much detail as possible when writing the description of your bug report.
 Providing information and examples will help us resolve issues faster.
 
-Contributing Code or Examples
------------------------------
+Contributing Code
+-----------------
 We follow a standard Forking Workflow for code changes and additions.
-Submitted code goes through the pull request process for `continuous integration (CI) testing <./Contributing.html#continuous-integration>`_ and comments.
+Submitted code goes through the pull request process for `continuous integration (CI) testing <../project/Testing.html#continuous-integration>`_ and comments.
 
 General Guidelines
 ^^^^^^^^^^^^^^^^^^
@@ -65,19 +67,6 @@ Adding Examples
 Examples may be in the form of executable scripts or interactive Jupyter Notebooks
 Fully working (but unrendered) examples should be submitted with the same steps as above.
 
-Continuous Integration
-^^^^^^^^^^^^^^^^^^^^^^
-We use `GitHub Actions <https://github.com/pyTMD/timescale/actions>`_ continuous integration (CI) services to build and test the project on Linux (Ubuntu) and Mac Operating Systems.
-The configuration files for this service are in the `GitHub workflows <https://github.com/pyTMD/timescale/tree/main/.github/workflows>`_ directory.
-The workflows rely on the `environment.yml <https://github.com/pyTMD/timescale/blob/main/environment.yml>`_ and `requirements-dev.txt <https://github.com/pyTMD/timescale/blob/main/requirements-dev.txt>`_ files to install the required dependencies.
-
-The GitHub Actions jobs include:
-
-* Updating `leap second <https://github.com/pyTMD/timescale/blob/main/timescale/data/leap-seconds.list>`_ and `delta time  <https://github.com/pyTMD/timescale/blob/main/timescale/data/merged_deltat.list>`_ files
-* Running `flake8 <https://flake8.pycqa.org/en/latest/>`_ to check the code for style and compilation errors
-* Running the test suite on multiple combinations of OS and Python version
-* Uploading source and wheel distributions to `PyPI <https://pypi.org/project/timescale/>`_ (on releases)
-
 Semantic Commit Messages
 ^^^^^^^^^^^^^^^^^^^^^^^^
 
@@ -96,5 +85,5 @@ where ``<type>`` is one of the following:
 - ``docs``: changing the documentation
 - ``style``: changing the line order or adding comments
 - ``refactor``: changing the names of variables or programs
-- ``ci``: changing the `continuous integration <./Contributing.html#continuous-integration>`_ configuration files or scripts
-- ``test``: adding or updating `continuous integration tests <./Contributing.html#continuous-integration>`_
+- ``ci``: changing the `continuous integration <../project/Testing.html#continuous-integration>`_ configuration files or scripts
+- ``test``: adding or updating `continuous integration tests <../project/Testing.html#continuous-integration>`_

doc/source/getting_started/Getting-Started.rst

@@ -76,4 +76,7 @@ There are a few different ways to create a ``Timescale`` object:
     ts = timescale.from_julian(JD)
 
 ``Timescale`` objects can be used to convert epochs, convert to different time standards, convert to ``datetime`` arrays, and other time conversions.
-See the `API Reference <../api_reference/time.html#timescale.time.Timescale>`_ for more information.
+
+.. tip::
+
+    See the `API Reference <../api_reference/time.html#timescale.time.Timescale>`_ for more information.

doc/source/index.rst

@@ -110,6 +110,7 @@ Project Details
 
     project/Contributors.rst
     project/Licenses.rst
+    project/Testing.rst
     project/Citations.rst
 
 .. toctree::

doc/source/project/Citations.rst

@@ -10,7 +10,7 @@ Program (NPP) at NASA Goddard Space Flight Center (GSFC), administered by
 Universities Space Research Association (USRA) under contract with NASA.
 It is currently supported under the NASA Cryospheric Sciences Program (Grant Number 80NSSC22K0379).
 
-If you have used ``timescale`` in your work, please consider citing our library:
+.. admonition:: Please consider citing our library
 
     T. C. Sutterley, K. Alley, K. Brunt, S. Howard, L. Padman, and M. Siegfried,
     "timescale: Python tools for time and astronomical calculations", (2023).
@@ -41,8 +41,10 @@ Disclaimer
 This package includes software developed at NASA Goddard Space Flight Center (GSFC) and the University
 of Washington Applied Physics Laboratory (UW-APL).
 It is not sponsored or maintained by the Universities Space Research Association (USRA), AVISO or NASA.
-Outputs from this software should be used for scientific or technical purposes only.
-This software should not be used for coastal navigation or any application that may risk life or property.
+
+.. warning::
+    Outputs from this software should be used for scientific or technical purposes only.
+    This software should not be used for coastal navigation or *any application that may risk life or property*.
 
 .. |auml|    unicode:: U+00E4 .. LATIN SMALL LETTER A WITH DIAERESIS
 .. |uuml|    unicode:: U+00FC .. LATIN SMALL LETTER U WITH DIAERESIS