Skip to content

Commit

Permalink
More test edits
Browse files Browse the repository at this point in the history
  • Loading branch information
mdpiper committed Nov 3, 2023
1 parent 36a3e7e commit ed2f440
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,19 @@ pymt_heatf
This is an example of building a model,
written in Fortran and wrapped in Python with the `babelizer <https://github.com/csdms/babelizer>`_,
with the `meson-python <https://meson-python.readthedocs.io/en/latest/>`_ build system
using a *pyproject.toml* file to describe the build.
using only a *pyproject.toml* file for project metadata.

Build/Install
-------------

This is a sketch of how to build and install this project.
This is a sketch of how to build and install this project with either ``conda`` or ``pip``.

With conda
..........

1. Create a conda environment from the *environment.yml* file and activate it
1. Create a conda environment from the included *environment.yml* file and activate it
2. Build/install the `Fortran BMI example <https://github.com/csdms/bmi-example-fortran/#buildinstall>`_
3. Build/install this project with:
3. Build/install the project with:

.. code-block:: bash
Expand All @@ -29,15 +29,15 @@ With pip
Make, CMake, and a Fortran compiler are required.

1. Create a virtual environment
2. Build/install the `Fortran BMI specification <https://github.com/csdms/bmi-fortran/#buildinstall>`_ (it's not installable through ``pip``)
3. Build/install the `Fortran BMI example <https://github.com/csdms/bmi-example-fortran/#buildinstall>`_
4. Install the build system requirements through ``pip``:
2. Install the build system requirements through ``pip``:

.. code-block:: bash
$ pip install meson-python meson ninja cython numpy bmipy
5. Build/install this project with:
3. Build/install the `Fortran BMI specification <https://github.com/csdms/bmi-fortran/#buildinstall>`_ (it's not installable through ``pip``)
4. Build/install the `Fortran BMI example <https://github.com/csdms/bmi-example-fortran/#buildinstall>`_
5. Build/install the project with:

.. code-block:: bash
Expand All @@ -58,4 +58,4 @@ Import the *pymt* component:
>>> from pymt.MODELS import HeatModelF
Try the examples in the `examples` directory.
Try the examples in the *examples* directory.

0 comments on commit ed2f440

Please sign in to comment.