Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update C and Fortran docs examples #97

Merged
merged 26 commits into from
Apr 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
fd4756b
Rename conda env file for C example
mdpiper Apr 2, 2024
2d132d2
Match C example babel.toml with 'babelize sample-config' output
mdpiper Apr 2, 2024
3b433d6
Update C example through babelizing
mdpiper Apr 2, 2024
edf60ca
Rename C example
mdpiper Apr 2, 2024
db955a9
Update reference to C example from Fortran example
mdpiper Apr 2, 2024
98cf829
Update C example through installation
mdpiper Apr 3, 2024
fa14f96
Replace Finder image with 'tree' output to show final directory struc…
mdpiper Apr 3, 2024
b82b1b4
Include bmi-tester in example environment
mdpiper Apr 3, 2024
e4727ad
Move parameters for C example to their own directory
mdpiper Apr 3, 2024
0632fa5
Move Python examples to c directory
mdpiper Apr 3, 2024
c4d15ea
Include pymt in example environment
mdpiper Apr 3, 2024
ae533ff
Update Python examples for C heat model
mdpiper Apr 3, 2024
ac642d3
Update location of C Python example
mdpiper Apr 3, 2024
8d5a121
Finish updating C example
mdpiper Apr 3, 2024
f571e71
Show a smaller tree for final result
mdpiper Apr 3, 2024
f202a97
Update Fortran environment file; relax bmi-tester version requirement
mdpiper Apr 3, 2024
7460ecb
Update HeatF babelizer config file
mdpiper Apr 3, 2024
1270529
Minor edits; fix typos
mdpiper Apr 3, 2024
5c8b334
Add Fortran-Python examples
mdpiper Apr 3, 2024
2be54ed
Fix typo
mdpiper Apr 3, 2024
5703222
Update the Fortran example to match the C example
mdpiper Apr 3, 2024
049917b
Add news fragment
mdpiper Apr 3, 2024
f636241
Add code of conduct document to repo and docs
mdpiper Apr 4, 2024
daf0991
Remove obsolete docs makefiles
mdpiper Apr 4, 2024
f811c96
Add news fragments
mdpiper Apr 4, 2024
4f42303
Merge branch 'develop' into mdpiper/revise-docs-examples
mcflugen Apr 5, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions CODE-OF-CONDUCT.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Code of Conduct
---------------

Everyone participating in this project is governed by the CSDMS `Code of Conduct`_.
By participating, you are expected to uphold this code.

.. Links

.. _Code of Conduct: https://github.com/csdms/project/blob/main/CODE-OF-CONDUCT.md
20 changes: 0 additions & 20 deletions docs/Makefile

This file was deleted.

35 changes: 0 additions & 35 deletions docs/make.bat

This file was deleted.

Binary file removed docs/source/_static/babelizer-bmi-example-c.png
Binary file not shown.
26 changes: 19 additions & 7 deletions docs/source/babel_heatc.toml
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
[library]
[library.HeatModel]
# See https://babelizer.readthedocs.io/ for more information

# Describe the library being wrapped.
[library.HeatC]
language = "c"
library = "bmiheatc"
header = "bmi_heat.h"
entry_point = "register_bmi_heat"

# Describe compiler options need to build the library being wrapped.
[build]
undef_macros = []
define_macros = []
Expand All @@ -13,17 +16,26 @@ library_dirs = []
include_dirs = []
extra_compile_args = []

# Describe the newly wrapped package.
[package]
name = "pymt_heatc"
requirements = [""]
requirements = []

[info]
github_username = "pymt-lab"
package_author = "csdms"
package_author_email = "[email protected]"
package_license = "MIT"
summary = "PyMT plugin for the C heat model"
package_license = "MIT License"
summary = "PyMT component for the C heat model"

[ci]
python_version = ["3.9"]
os = ["linux", "mac", "windows"]
python_version = [
"3.10",
"3.11",
"3.12",
]
os = [
"linux",
"mac",
"windows",
]
23 changes: 18 additions & 5 deletions docs/source/babel_heatf.toml
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
[library.HeatModel]
# See https://babelizer.readthedocs.io/ for more information

# Describe the library being wrapped.
[library.HeatF]
language = "fortran"
library = "bmiheatf"
header = ""
entry_point = "bmi_heat"

# Describe compiler options need to build the library being wrapped.
[build]
undef_macros = []
define_macros = []
Expand All @@ -12,17 +16,26 @@ library_dirs = []
include_dirs = []
extra_compile_args = []

# Describe the newly wrapped package.
[package]
name = "pymt_heatf"
requirements = [""]
requirements = []

[info]
github_username = "pymt-lab"
package_author = "csdms"
package_author_email = "[email protected]"
package_license = "MIT License"
summary = "PyMT plugin for the Fortran heat model"
summary = "PyMT component for the Fortran heat model"

[ci]
python_version = ["3.9"]
os = ["linux", "mac", "windows"]
python_version = [
"3.10",
"3.11",
"3.12",
]
os = [
"linux",
"mac",
"windows",
]
1 change: 1 addition & 0 deletions docs/source/code-of-conduct.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. include:: ../../CODE-OF-CONDUCT.rst
6 changes: 4 additions & 2 deletions docs/source/environment.yml → docs/source/environment-c.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# A conda environment file for the babelizer example
name: wrap
# A conda environment file for the babelizer C example
name: wrap-c
channels:
- conda-forge
dependencies:
Expand All @@ -10,3 +10,5 @@ dependencies:
- c-compiler
- bmi-c
- babelizer
- bmi-tester
- pymt>=1.3
4 changes: 3 additions & 1 deletion docs/source/environment-fortran.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# A conda environment file for the babelizer Fortran example
name: wrap
name: wrap-f
channels:
- conda-forge
dependencies:
Expand All @@ -10,3 +10,5 @@ dependencies:
- fortran-compiler
- bmi-fortran
- babelizer
- bmi-tester
- pymt>=1.3
Loading
Loading