Skip to content

Commit 2f5b414

Browse files
committed
Add instructions for building with pip
1 parent 279d239 commit 2f5b414

File tree

1 file changed

+21
-2
lines changed

1 file changed

+21
-2
lines changed

README.rst

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,36 @@ pymt_heatf
55
This is an example of building a model,
66
written in Fortran and wrapped in Python with the `babelizer <https://github.com/csdms/babelizer>`_,
77
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 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` and activate it
15+
With conda
16+
..........
17+
18+
1. Create a conda environment from the *environment.yml* file and activate it
1619
2. Build/install the `Fortran BMI example <https://github.com/csdms/bmi-example-fortran/#buildinstall>`_
1720
3. Build/install this project with ``make install``
1821

22+
With pip
23+
........
24+
25+
Make, CMake, and a Fortran compiler are required.
26+
27+
1. Create a virtual environment
28+
2. Build/install the `Fortran BMI specification <https://github.com/csdms/bmi-fortran/#buildinstall>`_ (it's not installable through ``pip``)
29+
3. Build/install the `Fortran BMI example <https://github.com/csdms/bmi-example-fortran/#buildinstall>`_
30+
4. Install the build system requirements through ``pip``:
31+
32+
.. code-block:: bash
33+
34+
$ pip install meson-python meson ninja cython numpy bmipy
35+
36+
5. Build/install this project with ``make install``
37+
1938
Use
2039
---
2140

0 commit comments

Comments
 (0)