diff --git a/AUTHORS.rst b/AUTHORS.rst index 20e214f9..fb650606 100644 --- a/AUTHORS.rst +++ b/AUTHORS.rst @@ -2,4 +2,6 @@ Authors ======= +* Koenraad Beckers - https://github.com/kfbeckers +* Malcolm Ross - https://github.com/malcolm-dsider * softwareengineerprogrammer - https://github.com/softwareengineerprogrammer diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 348b2cfc..e4d2961b 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -38,7 +38,8 @@ Development To set up `python-geophires-x` for local development: 1. Fork `python-geophires-x `_ - (look for the "Fork" button). + (look for the "Fork" button). Enable Actions on your fork. + 2. Clone your fork locally:: git clone git@github.com:NREL/python-geophires-x.git diff --git a/README.rst b/README.rst index 455ba741..84925c06 100644 --- a/README.rst +++ b/README.rst @@ -4,7 +4,9 @@ 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. -Ported from https://github.com/malcolm-dsider/GEOPHIRES-X and https://github.com/softwareengineerprogrammer/python-geophires-x using https://github.com/ionelmc/cookiecutter-pylibrary/. +Ported from `malcolm-dsider/GEOPHIRES-X `_ +and `softwareengineerprogrammer/python-geophires-x `_ +using `ionelmc/cookiecutter-pylibrary `_. * Free software: MIT license @@ -58,33 +60,36 @@ Install the in-development version with:: (Eventually package will be published to PyPi, enabling ``pip install geophires-x``) +Documentation +============= -Dev Setup -========= -1. Setup and activate virtualenv (https://virtualenv.pypa.io/en/latest/installation.html#via-pip):: +See `test_geophires_x.py `_ for example usage of the client - python -m venv venv - source venv/bin/activate + pre-commit install -2. Install dependencies in setup.py:: - pip install . -3. Setup pre-commit (https://pre-commit.com/):: +Development +=========== - pre-commit install +Local Setup +----------- +0. Follow fork & clone instructions in `CONTRIBUTING.rst `_ -Documentation -============= +1. Set up and activate `virtualenv `_:: + python -m venv venv + source venv/bin/activate -See https://github.com/NREL/python-geophires-x/blob/main/tests/test_geophires_x.py for example usage +2. Install dependencies in setup.py:: + + pip install -e . + +3. Set up `pre-commit `_:: -Development -=========== To run all the tests run::