Skip to content

Commit 54f43b4

Browse files
mdpipermcflugen
mdpiper
and
mcflugen
authored
Update C and Fortran docs examples (#97)
* Rename conda env file for C example * Match C example babel.toml with 'babelize sample-config' output * Update C example through babelizing * Rename C example [skip ci] * Update reference to C example from Fortran example * Update C example through installation [skip ci] * Replace Finder image with 'tree' output to show final directory structure This hopefully makes the result clearer and removes a binary file from the repo. [skip-ci] * Include bmi-tester in example environment * Move parameters for C example to their own directory * Move Python examples to c directory * Include pymt in example environment * Update Python examples for C heat model * Update location of C Python example * Finish updating C example [skip-ci] * Show a smaller tree for final result * Update Fortran environment file; relax bmi-tester version requirement * Update HeatF babelizer config file * Minor edits; fix typos * Add Fortran-Python examples * Fix typo * Update the Fortran example to match the C example * Add news fragment * Add code of conduct document to repo and docs * Remove obsolete docs makefiles * Add news fragments --------- Co-authored-by: mcflugen <[email protected]>
1 parent 8b84c83 commit 54f43b4

25 files changed

+445
-358
lines changed

‎CODE-OF-CONDUCT.rst‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Code of Conduct
2+
---------------
3+
4+
Everyone participating in this project is governed by the CSDMS `Code of Conduct`_.
5+
By participating, you are expected to uphold this code.
6+
7+
.. Links
8+
9+
.. _Code of Conduct: https://github.com/csdms/project/blob/main/CODE-OF-CONDUCT.md

‎docs/Makefile‎

Lines changed: 0 additions & 20 deletions
This file was deleted.

‎docs/make.bat‎

Lines changed: 0 additions & 35 deletions
This file was deleted.

‎docs/source/_static/babelizer-bmi-example-c.png‎

-181 KB
Binary file not shown.

‎docs/source/babel_heatc.toml‎

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
1-
[library]
2-
[library.HeatModel]
1+
# See https://babelizer.readthedocs.io/ for more information
2+
3+
# Describe the library being wrapped.
4+
[library.HeatC]
35
language = "c"
46
library = "bmiheatc"
57
header = "bmi_heat.h"
68
entry_point = "register_bmi_heat"
79

10+
# Describe compiler options need to build the library being wrapped.
811
[build]
912
undef_macros = []
1013
define_macros = []
@@ -13,17 +16,26 @@ library_dirs = []
1316
include_dirs = []
1417
extra_compile_args = []
1518

19+
# Describe the newly wrapped package.
1620
[package]
1721
name = "pymt_heatc"
18-
requirements = [""]
22+
requirements = []
1923

2024
[info]
2125
github_username = "pymt-lab"
2226
package_author = "csdms"
2327
package_author_email = "[email protected]"
24-
package_license = "MIT"
25-
summary = "PyMT plugin for the C heat model"
28+
package_license = "MIT License"
29+
summary = "PyMT component for the C heat model"
2630

2731
[ci]
28-
python_version = ["3.9"]
29-
os = ["linux", "mac", "windows"]
32+
python_version = [
33+
"3.10",
34+
"3.11",
35+
"3.12",
36+
]
37+
os = [
38+
"linux",
39+
"mac",
40+
"windows",
41+
]

‎docs/source/babel_heatf.toml‎

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
1-
[library.HeatModel]
1+
# See https://babelizer.readthedocs.io/ for more information
2+
3+
# Describe the library being wrapped.
4+
[library.HeatF]
25
language = "fortran"
36
library = "bmiheatf"
47
header = ""
58
entry_point = "bmi_heat"
69

10+
# Describe compiler options need to build the library being wrapped.
711
[build]
812
undef_macros = []
913
define_macros = []
@@ -12,17 +16,26 @@ library_dirs = []
1216
include_dirs = []
1317
extra_compile_args = []
1418

19+
# Describe the newly wrapped package.
1520
[package]
1621
name = "pymt_heatf"
17-
requirements = [""]
22+
requirements = []
1823

1924
[info]
2025
github_username = "pymt-lab"
2126
package_author = "csdms"
2227
package_author_email = "[email protected]"
2328
package_license = "MIT License"
24-
summary = "PyMT plugin for the Fortran heat model"
29+
summary = "PyMT component for the Fortran heat model"
2530

2631
[ci]
27-
python_version = ["3.9"]
28-
os = ["linux", "mac", "windows"]
32+
python_version = [
33+
"3.10",
34+
"3.11",
35+
"3.12",
36+
]
37+
os = [
38+
"linux",
39+
"mac",
40+
"windows",
41+
]

‎docs/source/code-of-conduct.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../../CODE-OF-CONDUCT.rst

‎docs/source/environment.yml‎ renamed to ‎docs/source/environment-c.yml‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
# A conda environment file for the babelizer example
2-
name: wrap
1+
# A conda environment file for the babelizer C example
2+
name: wrap-c
33
channels:
44
- conda-forge
55
dependencies:
@@ -10,3 +10,5 @@ dependencies:
1010
- c-compiler
1111
- bmi-c
1212
- babelizer
13+
- bmi-tester
14+
- pymt>=1.3

‎docs/source/environment-fortran.yml‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# A conda environment file for the babelizer Fortran example
2-
name: wrap
2+
name: wrap-f
33
channels:
44
- conda-forge
55
dependencies:
@@ -10,3 +10,5 @@ dependencies:
1010
- fortran-compiler
1111
- bmi-fortran
1212
- babelizer
13+
- bmi-tester
14+
- pymt>=1.3

0 commit comments

Comments
 (0)