Skip to content

Commit 7abc33a

Browse files
felipearochafelipearocha
committed
chore(release): prep v1.1.1 — Zenodo metadata, DOI badge, How to Cite
- Add .zenodo.json with deposit metadata (creators, affiliation, keywords, references) - Add DOI badge placeholder and How to Cite section in README.md - Add CITATION.cff with author affiliation and identifiers - Bump version to 1.1.1
1 parent 527bf9e commit 7abc33a

4 files changed

Lines changed: 120 additions & 2 deletions

File tree

‎.zenodo.json‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
{
2+
"title": "Integrity Code Series - Week 9 - CUI Coupled Thermohygro-Electrochemical Simulation",
3+
"description": "<p>Three-way coupled physics-first simulator for Corrosion Under Insulation (CUI) on insulated carbon-steel process piping. Couples Fourier heat conduction through the insulation annulus, Philip-de Vries hygrothermal moisture transport driven by capillary and thermal gradients, and Butler-Volmer electrochemical corrosion kinetics at the steel surface. All three fields are advanced together via Strang second-order operator splitting. A DFOS-informed inverse problem recovers moisture source magnitude and location from outer-cladding temperature observations.</p><p>Anchored to AMPP 2022 (CUI causes ~60% of refinery pipe leaks), API RP 583 critical temperature window (50-175C), and PHMSA Docket 2026-1520 (April 24, 2026). 151 tests, 5 analytical benchmarks.</p>",
4+
"upload_type": "software",
5+
"access_right": "open",
6+
"license": "MIT",
7+
"creators": [
8+
{
9+
"name": "Rocha, Felipe",
10+
"affiliation": "Independent Researcher"
11+
}
12+
],
13+
"keywords": [
14+
"CUI",
15+
"corrosion under insulation",
16+
"thermohygro-electrochemical",
17+
"Strang splitting",
18+
"Philip-de Vries",
19+
"Fourier conduction",
20+
"Butler-Volmer",
21+
"DFOS",
22+
"distributed fiber optic sensing",
23+
"inverse problem",
24+
"API RP 583",
25+
"pipeline integrity",
26+
"PHMSA"
27+
],
28+
"related_identifiers": [
29+
{
30+
"relation": "isSupplementTo",
31+
"identifier": "https://github.com/felipearocha/integrity-code-series-week9-cui",
32+
"scheme": "url",
33+
"resource_type": "software"
34+
}
35+
],
36+
"references": [
37+
"API RP 583 (2014). Corrosion Under Insulation and Fireproofing.",
38+
"Philip J.R., de Vries D.A. (1957). Moisture movement in porous materials under temperature gradients. Transactions, AGU 38(2): 222-232.",
39+
"Strang G. (1968). On the construction and comparison of difference schemes. SIAM J. Numerical Analysis 5(3): 506-517.",
40+
"AMPP (2022). Corrosion Under Insulation Industry Survey.",
41+
"PHMSA Docket 2026-1520 (April 24, 2026). External corrosion threats on hazardous liquid pipelines."
42+
],
43+
"language": "eng",
44+
"version": "1.1.1"
45+
}

‎CITATION.cff‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
cff-version: 1.2.0
2+
title: "Integrity Code Series - Week 9 - CUI Coupled Thermohygro-Electrochemical Simulation"
3+
message: "If you use this software, please cite it using the metadata below."
4+
type: software
5+
authors:
6+
- family-names: Rocha
7+
given-names: Felipe
8+
affiliation: "Independent Researcher"
9+
# orcid: "https://orcid.org/0000-0000-0000-0000" # TODO: replace once ORCID is provisioned
10+
repository-code: "https://github.com/felipearocha/integrity-code-series-week9-cui"
11+
url: "https://github.com/felipearocha/integrity-code-series-week9-cui"
12+
abstract: >
13+
Three-way coupled physics-first simulator for Corrosion Under Insulation (CUI) on insulated carbon-steel process piping. Couples Fourier heat conduction through the insulation annulus, Philip-de Vries hygrothermal moisture transport driven by capillary and thermal gradients, and Butler-Volmer electrochemical corrosion kinetics at the steel surface. All three fields are advanced together via Strang second-order operator splitting. A DFOS-informed inverse problem recovers moisture source magnitude and location from outer-cladding temperature observations. Anchored to AMPP 2022 (CUI causes ~60% of refinery pipe leaks), API RP 583 critical temperature window (50-175C), and PHMSA Docket 2026-1520 (April 24, 2026). 151 tests, 5 analytical benchmarks.
14+
keywords:
15+
- CUI
16+
- corrosion under insulation
17+
- thermohygro-electrochemical
18+
- Strang splitting
19+
- Philip-de Vries
20+
- Fourier conduction
21+
- Butler-Volmer
22+
- DFOS
23+
- distributed fiber optic sensing
24+
- inverse problem
25+
- API RP 583
26+
- pipeline integrity
27+
- PHMSA
28+
license: MIT
29+
version: "1.1.1"
30+
date-released: "2026-05-13"
31+
identifiers:
32+
- type: url
33+
value: "https://github.com/felipearocha/integrity-code-series-week9-cui/releases/tag/v1.1.1"
34+
description: "GitHub release tag v1.1.1"
35+
# After first Zenodo release, replace the doi block below with the real value:
36+
# - type: doi
37+
# value: "10.5281/zenodo.XXXXXXX"
38+
# description: "Concept DOI (always resolves to latest version)"

‎README.md‎

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# ICS2 Week 9 — CUI Coupled Thermohygro-Electrochemical Simulation
22

3+
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.XXXXXXX.svg)](https://doi.org/10.5281/zenodo.XXXXXXX)
4+
35
[![CI](https://github.com/felipearocha/integrity-code-series-week9-cui/actions/workflows/ci.yml/badge.svg)](https://github.com/felipearocha/integrity-code-series-week9-cui/actions/workflows/ci.yml)
46
[![Python](https://img.shields.io/badge/python-3.11%2B-blue.svg)](https://www.python.org/)
57
[![Tests](https://img.shields.io/badge/tests-151%20passing-brightgreen.svg)](#testing)
@@ -237,4 +239,37 @@ API RP 583, API 579-1, PHMSA regulations take precedence over model output.
237239

238240
---
239241

240-
Integrity Code Series — ICS2 | Week 9 | Physics-first. Verification over visibility.
242+
Integrity Code Series — ICS2 | Week 9 | Physics-first. Verification over visibility.
243+
---
244+
245+
## How to Cite
246+
247+
If this software contributes to your work, please cite both the software (this repository) and the underlying methods it implements.
248+
249+
**Software (archived release):**
250+
251+
> Rocha, F. (2026). *Integrity Code Series - Week 9 - CUI Coupled Thermohygro-Electrochemical Simulation* (Version 1.1.1) [Computer software]. Zenodo. https://doi.org/10.5281/zenodo.XXXXXXX
252+
253+
**BibTeX:**
254+
255+
```bibtex
256+
@software{rocha_2026_week9,
257+
author = {Rocha, Felipe},
258+
title = {{Integrity Code Series - Week 9 - CUI Coupled Thermohygro-Electrochemical Simulation}},
259+
year = 2026,
260+
publisher = {Zenodo},
261+
version = {v1.1.1},
262+
doi = {10.5281/zenodo.XXXXXXX},
263+
url = {https://doi.org/10.5281/zenodo.XXXXXXX}
264+
}
265+
```
266+
267+
The two DOIs Zenodo provides are:
268+
269+
| DOI | What it points to |
270+
|--------------------------------------|--------------------------------------------------------------------|
271+
| `10.5281/zenodo.XXXXXXX` (concept) | Always resolves to the latest version - use this for citation. |
272+
| `10.5281/zenodo.YYYYYYY` (version) | Pinned to v1.1.1 specifically - use when reproducibility matters. |
273+
274+
A machine-readable citation file is also available in [`CITATION.cff`](CITATION.cff) - GitHub will display a "Cite this repository" widget at the top right of the repo page that exports BibTeX / APA / RIS automatically.
275+

‎pyproject.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
44

55
[project]
66
name = "ics2-week9-cui-thermohygro"
7-
version = "1.1.0"
7+
version = "1.1.1"
88
description = "Coupled thermohygro-electrochemical CUI simulator with DFOS-informed inverse problem (Integrity Code Series, Week 9)."
99
readme = "README.md"
1010
requires-python = ">=3.11"

0 commit comments

Comments
 (0)