@@ -5,16 +5,43 @@ pymt_heatf
5
5
This is an example of building a model,
6
6
written in Fortran and wrapped in Python with the `babelizer <https://github.com/csdms/babelizer >`_,
7
7
with the `meson-python <https://meson-python.readthedocs.io/en/latest/ >`_ build system
8
- using a `` pyproject.toml `` file to describe the build .
8
+ using only a * pyproject.toml * file for project metadata .
9
9
10
10
Build/Install
11
11
-------------
12
12
13
- This is a sketch of how to build and install this project.
13
+ This is a sketch of how to build and install this project with either `` conda `` or `` pip `` .
14
14
15
- 1. Create the conda environment from `environment.yml ` and activate it
15
+ With conda
16
+ ..........
17
+
18
+ 1. Create a conda environment from the included *environment.yml * file and activate it
16
19
2. Build/install the `Fortran BMI example <https://github.com/csdms/bmi-example-fortran/#buildinstall >`_
17
- 3. Build/install this project with ``make install ``
20
+ 3. Build/install the project with:
21
+
22
+ .. code-block :: bash
23
+
24
+ $ make install
25
+
26
+ With pip
27
+ ........
28
+
29
+ Make, CMake, and a Fortran compiler are required.
30
+
31
+ 1. Create a virtual environment
32
+ 2. Install the build system requirements through ``pip ``:
33
+
34
+ .. code-block :: bash
35
+
36
+ $ pip install meson-python meson ninja cython numpy bmipy
37
+
38
+ 3. Build/install the `Fortran BMI specification <https://github.com/csdms/bmi-fortran/#buildinstall >`_ (it's not installable through ``pip ``)
39
+ 4. Build/install the `Fortran BMI example <https://github.com/csdms/bmi-example-fortran/#buildinstall >`_
40
+ 5. Build/install the project with:
41
+
42
+ .. code-block :: bash
43
+
44
+ $ make install
18
45
19
46
Use
20
47
---
@@ -31,4 +58,4 @@ Import the *pymt* component:
31
58
32
59
>> > from pymt.MODELS import HeatModelF
33
60
34
- Try the examples in the ` examples ` directory.
61
+ Try the examples in the * examples * directory.
0 commit comments