diff --git a/README.rst b/README.rst index ec4bfa0..096e1c0 100644 --- a/README.rst +++ b/README.rst @@ -11,9 +11,6 @@ :target: https://babelizer.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status -.. image:: https://img.shields.io/badge/code%20style-black-000000.svg - :target: https://github.com/csdms/babelizer - .. image:: https://coveralls.io/repos/github/csdms/babelizer/badge.svg?branch=develop :target: https://coveralls.io/github/csdms/babelizer?branch=develop @@ -21,9 +18,10 @@ The Babelizer: Wrap BMI libraries with Python bindings ====================================================== - -The *babelizer* is a utility for wrapping a library that exposes a `Basic Model Interface`_ (BMI) so that it can be -imported as a Python package. +The *babelizer* is an open source Python utility, +developed by the `Community Surface Dynamics Modeling System`_ (CSDMS), +for wrapping a library that exposes a `Basic Model Interface`_ (BMI) +so that it can be imported as a Python package. Supported languages include: @@ -32,23 +30,12 @@ Supported languages include: * Fortran * Python -Full documentation for the *babelizer*, including examples, -can be found at https://babelizer.readthedocs.io/. - - -The Babelizer is part of the CSDMS Workbench --------------------------------------------- - The *babelizer* is an element of the `CSDMS Workbench`_, an integrated system of software tools, technologies, and standards -for building and coupling models. The Workbench provides two Python -frameworks for model coupling, *pymt* and *landlab*. -The *babelizer* was written to bring models written in other languages into -these frameworks. -However, as long as your model -satisfies the requirements below, you can use the *babelizer* -to bring your model into Python without having to use any of the -other tools in the Workbench. +for building and coupling models. + +Full documentation for the *babelizer*, including examples, +can be found at https://babelizer.readthedocs.io/. Installation ------------ @@ -63,17 +50,25 @@ For more detailed information, including how to install the *babelizer* from source, see the `installation instructions`_ in the documentation. +Contributing +------------ + +If you wish to report bugs or request new features for the *babelizer*, +or if you would like to fix bugs and implement new features, +please see our `contributing`_ guidelines. +Contributions to the *babelizer* are `credited`_. + +Acknowledgments +--------------- + +The Community Surface Dynamics Modeling System is funded +by the U.S. National Science Foundation. + .. Links: +.. _Community Surface Dynamics Modeling System: https://csdms.colorado.edu .. _Basic Model Interface: https://bmi.readthedocs.io/ .. _CSDMS Workbench: https://csdms.colorado.edu/wiki/Workbench -.. _documentation: https://babelizer.readthedocs.io/ -.. _BMI C: https://github.com/csdms/bmi-c/ -.. _BMI C++: https://github.com/csdms/bmi-cxx/ -.. _BMI Fortran: https://github.com/csdms/bmi-fortran/ -.. _BMI Python: https://github.com/csdms/bmi-python/ -.. _BMI example C: https://github.com/csdms/bmi-example-c/ -.. _BMI example C++: https://github.com/csdms/bmi-example-cxx/ -.. _BMI example Fortran: https://github.com/csdms/bmi-example-fortran/ -.. _BMI example Python: https://github.com/csdms/bmi-example-python/ .. _installation instructions: https://babelizer.readthedocs.io/en/latest/install.html +.. _contributing: https://babelizer.readthedocs.io/en/latest/contributing.html +.. _credited: https://babelizer.readthedocs.io/en/latest/credits.html