Automatic push from FunctionsAPI

Cargo.toml

@@ -0,0 +1,11 @@
+[package]
+  edition = "2024"
+  name    = "web"
+  version = "0.1.0"
+
+[dependencies]
+  fathom-function      = { git = "ssh://git@github.com/fathom-io/pipeline-calculations.git", branch = "FTHM-13309/kriging" }
+  pipeline-application = { git = "ssh://git@github.com/fathom-io/pipeline-calculations.git", branch = "FTHM-13309/kriging" }
+  serde                = { version = "1.0.219", features = ["derive"] }
+  tokio                = { version = "1.43.0", features = ["macros", "rt-multi-thread"] }
+  uuid                 = { version = "1" }

README.md

@@ -1,2 +1,44 @@
-# d1f4e3974c4a434d9f726f23be156fe7
+# Time weighted corrosion rate calculation
 
+The objective of this calculation is to derive a final representative corrosion depth growth
+rate (mm/year) at each point along a pipeline using multiple In-Line Inspection (ILI) data sets,
+and to predict the likely depth of metal loss by a future target date (e.g. 24 October 2023)
+
+## Input
+
+### Arguments
+
+- `org_id`: as string which should be a valid `uuid` for the organization
+- `project_id`: the id of the data project where the pipeline data is found
+- `pipeline_id`: an `array` of `strings` which should each be a valid uuid representing a pipeline.
+- `target_date`: a `string` representing the date for which the corrosion growth rate should be predicted.
+
+## Creating the function on the platform
+
+To create this function on the platform using the `cli` set up the port forwarding as shown in README.
+
+Then run the following command to create the function.
+
+```bash
+cargo run functions create \
+  -f functions/acr_time_weighted \
+  -d "Run the time weighted corrosion rate calculation" \
+  -i org_id=string \
+  -i project_id=string \
+  -i target_date=string \
+  -i pipeline_id=array
+```
+
+## Testing the function locally
+
+You can run and test the function locally by running
+
+```bash
+cargo run
+```
+
+Then you can check it work with `curl` as follows
+
+```bash
+curl localhost:8080 -d $(jq '. | tojson' functions/acr_time_weighted/example_input.json)
+```

example_input.json

@@ -0,0 +1,8 @@
+{
+  "target_date": "2023-10-24",
+  "org_id": "2cbfe270-d195-48ad-aed1-24145924635c",
+  "pipeline_id": [
+    "01966d47-1d4c-7751-a1f1-0617caa3a00d"
+  ],
+  "project_id": "680b61b0aedd6f9e639d8699"
+}

src/main.rs

@@ -0,0 +1,33 @@
+use fathom_function::{chrono::NaiveDate, tracing};
+use pipeline_application::application::Application;
+use serde::{Deserialize, Serialize};
+use uuid::Uuid;
+
+#[fathom_function::function]
+async fn time_weighted_calculation(input: Input) -> Result<Output, String> {
+    let app = Application::new_from_compile_env(input.org_id, &input.project_id).unwrap();
+    for pipeline_id in input.pipeline_id {
+        app.time_weighted_calculation(pipeline_id, input.target_date)
+            .await
+            .map_err(|err| {
+                tracing::error!(%pipeline_id, ?err, "Error running time weighted corrosion calculation");
+                format!("{err:?}")
+            })?;
+    }
+    Ok(Output {
+        status: "Success".to_owned(),
+    })
+}
+
+#[derive(Debug, Serialize)]
+struct Output {
+    status: String,
+}
+
+#[derive(Debug, Deserialize)]
+struct Input {
+    org_id: Uuid,
+    project_id: String,
+    target_date: Option<NaiveDate>,
+    pipeline_id: Vec<Uuid>,
+}