Skip to content

Commit

Permalink
Tweak Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
rgieseke committed Mar 6, 2024
1 parent 6fd7db5 commit 7f35c35
Showing 1 changed file with 7 additions and 15 deletions.
22 changes: 7 additions & 15 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,21 +21,14 @@ model emulation, and uncertainty analyses.

`Hector <https://github.com/JGCRI/hector>`_ is written in C++ and
developed at the `Pacific Northwest National Laboratory
<https://www.pnnl.gov/>`_. The model description is published in

Hartin, C. A., Patel, P., Schwarber, A., Link, R. P., and
Bond-Lamberty, B. P.: A simple object-oriented and open-source
model for scientific and policy analyses of the global climate
system – Hector v1.0, Geosci. Model Dev., 8, 939-955,
`doi:10.5194/gmd-8-939-2015
<https://doi.org/10.5194/gmd-8-939-2015>`_, 2015.
<https://www.pnnl.gov/>`_.

See the Hector `repository <https://github.com/JGCRI/hector>`_ and
`wiki <https://github.com/JGCRI/hector/wiki>`_ for further
`documentation website <https://jgcri.github.io/hector/>`_ for further
information.

The Python interface **pyhector** is developed by `Sven Willner
<http://www.pik-potsdam.de/~willner/>`_ and `Robert Gieseke
<http://svenwillner.com>`_ and `Robert Gieseke
<https://github.com/rgieseke>`_.

Pyhector uses `pybind11 <https://github.com/pybind/pybind11>`_ to wrap
Expand All @@ -53,9 +46,8 @@ Prerequisites

`Hector <https://github.com/JGCRI/hector>`_ requires `Boost
<http://www.boost.org/>`_, so to install and use **pyhector** you need
to have the filesystem and system modules of *Boost* version
1.52 or later installed (see also the `Hector build
instructions <https://github.com/JGCRI/hector/wiki/BuildHector>`_).
to have the filesystem and system modules of *Boost* installed (see also the `Hector build
instructions <https://jgcri.github.io/hector/articles/BuildHector.html#standalone-executable>`_).

On Ubuntu/Debian these can be installed by invoking

Expand All @@ -78,7 +70,7 @@ welcome.
Install using pip
~~~~~~~~~~~~~~~~~

You can simply install **pyhector** from
You can install **pyhector** from
`PyPI <https://pypi.python.org/pypi/pyhector>`_ by invoking

.. code:: bash
Expand Down Expand Up @@ -106,7 +98,7 @@ Basic example
import pyhector
output = pyhector.run(pyhector.rcp26)
output = pyhector.run(pyhector.ssp126)
Advanced example
~~~~~~~~~~~~~~~~
Expand Down

0 comments on commit 7f35c35

Please sign in to comment.