convert rst to myst

Author: mcflugen

AUTHORS.md

@@ -0,0 +1,12 @@
+# Credits
+
+## Development Leads
+
+- [Eric Hutton](https://github.com/mcflugen)
+- [Mark Piper](https://github.com/mdpiper)
+
+## Contributors
+
+- [Tian Gan](https://github.com/gantian127)
+- [Scott Stewart](https://github.com/sc0tts)
+- [Mike Taves](https://github.com/mwtoews)

AUTHORS.rst

@@ -1,124 +1,75 @@
-Changelog for bmi-tester
-========================
+# Changelog for bmi-tester
 
-0.5.7 (unreleased)
-------------------
+## 0.5.7 (unreleased)
 
 - Nothing changed yet.
 
-
-0.5.6 (2023-12-15)
-------------------
+## 0.5.6 (2023-12-15)
 
 - Fix docs build (#36)
-
 - Updates for Python 3.12 (#35)
-
 - Move static metadata to setup.cfg; update requirements; update CI workflows (#32)
 
-
-0.5.5 (2021-03-31)
-------------------
+## 0.5.5 (2021-03-31)
 
 - Fixed documentation builds on readthedocs (#31)
-
 - Added usage and installation instructions to the README,
   and did a general cleaning up of the docs (#30)
-
 - Fixed a bug when validating some cf-compliant units (#29)
-
 - Added gimli.units as a requirement for unit parsing (#29)
-
 - Added GitHub actions for continuous integration (#28)
 
-
-0.5.4 (2020-10-31)
-------------------
+## 0.5.4 (2020-10-31)
 
 - Removed the test for set_value as it's just too dangerous (#26)
-
 - Fixed tests that use get_grid_node_count on grids that
   are not unstructured (#27)
 
-
-0.5.3 (2020-10-19)
-------------------
+## 0.5.3 (2020-10-19)
 
 - Change tests that use ID arrays (e.g. face_nodes, edge_nodes, etc.) to
   allocate those array buffers as int32 (#25)
 
-
-0.5.2 (2020-10-09)
-------------------
+## 0.5.2 (2020-10-09)
 
 - Fixed a bug in the unstructured grid tests (#24)
 
-
-0.5.1 (2020-09-10)
-------------------
+## 0.5.1 (2020-09-10)
 
 - Fixed the time units check to allow dimensionless units (#22)
-
 - Fixed remaining bmi version strings to 2.0 (#23)
 
-0.5 (2020-09-02)
-----------------
+## 0.5 (2020-09-02)
 
 - Fixed an error with empty_var_buffer where it returned a read-only array (#20)
-
 - Fixed MANIFEST.in to include necessary source files (#21)
-
 - Added test stages where successive stages depend on one another (#19)
-
 - Cleaned up continuous integration and added Python 3.8 builds (#18)
 
-
-0.4.4 (2020-03-23)
-------------------
+## 0.4.4 (2020-03-23)
 
 - Added test for get_grid_node_count (#17)
 
-0.4.3 (2019-11-12)
-------------------
-
-
-0.4.2 (2019-07-24)
-------------------
-
-
-0.4.1 (2019-05-16)
-------------------
-
-
-0.4.0 (2018-10-25)
-------------------
-
-
-0.3.1 (2018-10-16)
-------------------
-
-
-0.3.0 (2018-09-30)
-------------------
+## 0.4.3 (2019-11-12)
 
+## 0.4.2 (2019-07-24)
 
-0.2.4 (2018-07-04)
-------------------
+## 0.4.1 (2019-05-16)
 
+## 0.4.0 (2018-10-25)
 
-0.2.2 (2018-07-03)
-------------------
+## 0.3.1 (2018-10-16)
 
+## 0.3.0 (2018-09-30)
 
-0.2.1 (2018-06-04)
-------------------
+## 0.2.4 (2018-07-04)
 
+## 0.2.2 (2018-07-03)
 
-0.2 (2018-06-04)
-----------------
+## 0.2.1 (2018-06-04)
 
+## 0.2 (2018-06-04)
 
-0.1.0 (2018-04-14)
-------------------
+## 0.1.0 (2018-04-14)
 
 - Initial release

CHANGES.rst CHANGES.md

@@ -1,7 +1,6 @@
-The MIT License (MIT)
-=====================
+# The MIT License (MIT)
 
-Copyright © `2020` `Community Surface Dynamics Modeling System`
+Copyright (c) `2020` `Community Surface Dynamics Modeling System`
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

CREDITS.rst

@@ -1,18 +1,30 @@
-bmi-tester: Test Basic Model Interface implementations
-======================================================
-
-|Build Status| |Documentation Status| |Coverage Status| |Conda Version|
-|Conda Downloads|
-
-About
------
+[anaconda-badge]: https://anaconda.org/conda-forge/bmi-tester/badges/version.svg
+[anaconda-link]: https://anaconda.org/conda-forge/bmi-tester
+[build-badge]: https://github.com/csdms/bmi-tester/actions/workflows/test.yml/badge.svg
+[build-link]: https://github.com/csdms/bmi-tester/actions/workflows/test.yml
+[coverage-badge]: https://coveralls.io/repos/github/csdms/bmi-tester/badge.svg
+[coverage-link]: https://coveralls.io/github/csdms/bmi-tester
+[docs-badge]: https://readthedocs.org/projects/bmi-tester/badge/?version=latest
+[docs-link]: https://readthedocs.org/projects/bmi-tester/
+[pypi-badge]: https://badge.fury.io/py/bmi-tester.svg
+[pypi-link]: https://pypi.org/project/bmi-tester/
+[python-badge]: https://img.shields.io/pypi/pyversions/bmi-tester.svg
+
+# bmi-tester: Test Basic Model Interface implementations
+
+![[Build Status][build-link]][build-badge]
+![[PyPI][pypi-link]][pypi-badge]
+![[Anaconda][anaconda-link]][anaconda-badge]
+![[Python][pypi-link]][python-badge]
+![[Documentation][docs-link]][docs-badge]
+![[Coverage][coverage-link]][coverage-badge]
+
+## About
 
 The *bmi-tester* is a command-line utility and Python library for testing
 Basic Model Interface (BMI) implementations.
 
-
-Requirements
-------------
+## Requirements
 
 The *bmi-tester* requires Python 3. Additional dependencies can be found
 in the project's *requirements.txt* file and can be installed using either
@@ -29,95 +41,75 @@ that things are working as they should. These dependencies are listed
 in *requirements-testing.txt* and can all be install with either *pip*
 or *conda*.
 
-
-Installation
-------------
+## Installation
 
 To install, first create a new environment in which the project will be
 installed. This, although not necessary, will isolate the installation
 so that there won't be conflicts with your base *Python* installation.
 This can be done with *conda* as,
 
-.. code:: bash
+```bash
+conda create -n bmi-tester python=3
+conda activate bmi-tester
+```
 
-  $ conda create -n bmi-tester python=3
-  $ conda activate bmi-tester
-
-
-Stable Release
-++++++++++++++
+### Stable Release
 
 The *bmi-tester*, and its dependencies, can most easily be installed
 with *conda*,
 
-.. code:: bash
+```bash
+conda install bmi-tester -c conda-forge
+```
 
-  $ conda install bmi-tester -c conda-forge
-
-From Source
-+++++++++++
+### From Source
 
 After downloading the *bmi-tester* source code, run the following from
 the project's top-level folder (the one that contains *pyproject.toml*) to
 install into the current environment,
 
-.. code:: bash
-
-  $ pip install -e .
+```bash
+pip install -e .
+```
 
-Usage
------
+## Usage
 
 You can access the *bmi-tester* from the command line with the *bmi-test*
 command. Use the *--help* option to get a brief description of the
 command line arguments,
 
-.. code:: bash
-
-  $ bmi-test --help
+```bash
+bmi-test --help
+```
 
 The *bmi-test* command takes a single argument, the name of the entry point
 of the class that implements the BMI you would like to test. To demonstrate
 how this works, we will use the *Hydrotrend* model as an example. To install
 the Python BMI for *Hydrotrend*, use *conda*,
 
-.. code:: bash
-
-  $ conda install pymt_hydrotrend -c conda-forge
+```bash
+conda install pymt_hydrotrend -c conda-forge
+```
 
 Once installed, the following will test the BMI implementation for the
 *Hydrotrend* class,
 
-.. code:: bash
+```bash
+bmi-test pymt_hydrotrend:Hydrotrend
+```
 
-  $ bmi-test pymt_hydrotrend:Hydrotrend
-
-The entry point is given as *<model>:<class>*. That is, in Python you would
+The entry point is given as *\<model>:\<class>*. That is, in Python you would
 import the *Hydrotrend* class as,
 
-.. code:: python
-
-  >>> from pymt_hydrotrend import Hydrotrend
-
-
-Links
------
-
--  `Source code <http://github.com/csdms/bmi-tester>`__: The
-   *bmi-tester* source code repository.
--  `Documentation <http://bmi-tester.readthedocs.io/>`__: User
-   documentation for *bmi-tester*
--  `Get <http://bmi-tester.readthedocs.io/en/latest/getting.html>`__:
-   Installation instructions
+```python
+>>> from pymt_hydrotrend import Hydrotrend
+```
 
+## Links
 
-.. |Build Status| image:: https://github.com/csdms/bmi-tester/actions/workflows/test.yml/badge.svg
-   :target: https://github.com/csdms/bmi-tester/actions/workflows/test.yml
-.. |Documentation Status| image:: https://readthedocs.org/projects/bmi-tester/badge/?version=latest
-   :target: http://bmi-tester.readthedocs.io/en/latest/?badge=latest
-.. |Coverage Status| image:: https://coveralls.io/repos/github/csdms/bmi-tester/badge.svg
-   :target: https://coveralls.io/github/csdms/bmi-tester
-.. |Conda Version| image:: https://anaconda.org/conda-forge/bmi-tester/badges/version.svg
-   :target: https://anaconda.org/conda-forge/bmi-tester
-.. |Conda Downloads| image:: https://anaconda.org/conda-forge/bmi-tester/badges/downloads.svg
-   :target: https://anaconda.org/conda-forge/bmi-tester
+- [Source code](http://github.com/csdms/bmi-tester): The
+  *bmi-tester* source code repository.
+- [Documentation](http://bmi-tester.readthedocs.io/): User
+  documentation for *bmi-tester*
+- [Get](http://bmi-tester.readthedocs.io/en/latest/getting.html):
+  Installation instructions

LICENSE.rst LICENSE.md

@@ -87,8 +87,8 @@ requires = [
 build-backend = "setuptools.build_meta"
 
 [tool.setuptools.dynamic.readme]
-file = "README.rst"
-content-type = "text/x-rst"
+file = "README.md"
+content-type = "text/markdown"
 
 [tool.setuptools.dynamic.version]
 attr = "bmi_tester._version.__version__"