Skip to content

Commit

Permalink
README/AUTHORS cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
softwareengineerprogrammer committed Oct 10, 2023
1 parent 61eaadb commit 46b15b4
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 5 deletions.
3 changes: 2 additions & 1 deletion AUTHORS.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,5 @@ Authors

* Koenraad Beckers - https://github.com/kfbeckers
* Malcolm Ross - https://github.com/malcolm-dsider
* softwareengineerprogrammer - https://github.com/softwareengineerprogrammer
* Jonathan Pezzino - https://jonathanpezzino.com
* Kevin McCabe (GEOPHIRES v2.0) - [email protected]
14 changes: 10 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,12 @@ Overview

GEOPHIRES is a free and open-source geothermal techno-economic simulator. GEOPHIRES combines reservoir, wellbore, surface plant, and economic models to estimate the capital and operation and maintenance costs, instantaneous and lifetime energy production, and overall levelized cost of energy of a geothermal plant. Various reservoir conditions (EGS, doublets, etc.) and end-use options (electricity, direct-use heat, cogeneration) can be modeled. Users are encouraged to build upon to the GEOPHIRES framework to implement their own correlations and models.

GEOPHIRES-X is the successor version to `GEOPHIRES v2.0 <https://github.com/NREL/GEOPHIRES-v2>`_.
Ported from `malcolm-dsider/GEOPHIRES-X <https://github.com/malcolm-dsider/GEOPHIRES-X>`_
and `softwareengineerprogrammer/python-geophires-x <https://github.com/softwareengineerprogrammer/python-geophires-x>`_
using `ionelmc/cookiecutter-pylibrary <https://github.com/ionelmc/cookiecutter-pylibrary/>`_.

* Free software: MIT license
Free software: `MIT license <LICENSE>`_

.. start-badges
Expand All @@ -19,8 +20,9 @@ using `ionelmc/cookiecutter-pylibrary <https://github.com/ionelmc/cookiecutter-p
- | |github-actions|
|
* - package
- | |version| |wheel| |supported-versions| |supported-implementations|
| |commits-since|
- | |commits-since|

.. TODO add the following to package badge list once PyPy distribution enabled: |version| |wheel| |supported-versions| |supported-implementations|
.. |github-actions| image:: https://github.com/NREL/python-geophires-x/actions/workflows/github-actions.yml/badge.svg
:alt: GitHub Actions Build Status
Expand All @@ -42,7 +44,7 @@ using `ionelmc/cookiecutter-pylibrary <https://github.com/ionelmc/cookiecutter-p
:alt: Supported implementations
:target: https://pypi.org/project/geophires-x

.. |commits-since| image:: https://img.shields.io/github/commits-since/softwareengineerprogrammer/python-geophires-x/v3.1.2.svg
.. |commits-since| image:: https://img.shields.io/github/commits-since/NREL/python-geophires-x/v3.1.2.svg
:alt: Commits since latest release
:target: https://github.com/NREL/python-geophires-x/compare/v3.1.2...main

Expand Down Expand Up @@ -89,6 +91,10 @@ Prerequisite: Follow fork & clone instructions in `CONTRIBUTING.rst <CONTRIBUTIN

pre-commit install


Tox tests
---------

To run all the tests run::

tox
Expand Down

0 comments on commit 46b15b4

Please sign in to comment.