Skip to content

Commit d50b553

Browse files
committed
Include links and simple examples
1 parent 52204f4 commit d50b553

File tree

1 file changed

+17
-6
lines changed

1 file changed

+17
-6
lines changed

README.rst

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,32 @@ pymt_heatf
33
==========
44

55
This is an example of building a model,
6-
written in Fortran and wrapped in Python with the *babelizer*,
7-
with the *meson-python* build system
6+
written in Fortran and wrapped in Python with the `babelizer <https://github.com/csdms/babelizer>`_,
7+
with the `meson-python <https://meson-python.readthedocs.io/en/latest/>`_ build system
88
using a ``pyproject.toml`` file to describe the build.
99

1010
Build/Install
1111
-------------
1212

1313
This is a sketch of how to build and install this project.
1414

15-
1. Create the conda environment from `environment.yml`.
16-
2. Build/install the `Fortran BMI specification <https://github.com/csdms/bmi-fortran/#buildinstall>`_
17-
3. Build/install the `Fortran BMI example <https://github.com/csdms/bmi-example-fortran/#buildinstall>`_
18-
4. Build/install this project with ``make install``
15+
1. Create the conda environment from `environment.yml` and activate it
16+
2. Build/install the `Fortran BMI example <https://github.com/csdms/bmi-example-fortran/#buildinstall>`_
17+
3. Build/install this project with ``make install``
1918

2019
Use
2120
---
2221

22+
Import the standalone project into a Python session:
23+
24+
.. code-block:: python
25+
26+
>>> import pymt_heatf
27+
28+
Import the *pymt* component:
29+
30+
.. code-block:: python
31+
32+
>>> from pymt.MODELS import HeatModelF
33+
2334
Try the examples in the `examples` directory.

0 commit comments

Comments
 (0)