1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306
use crate::sketchbook::data_structs::{
DatasetData, DynPropertyData, SketchData, StatPropertyData, StatPropertyTypeData,
UninterpretedFnData, VariableData,
};
use crate::sketchbook::model::{Essentiality, ModelState, Monotonicity};
use crate::sketchbook::properties::shortcuts::*;
use crate::sketchbook::properties::{DynProperty, StatProperty};
use crate::sketchbook::{JsonSerde, Sketch};
use biodivine_lib_param_bn::{BooleanNetwork, ModelAnnotation};
use regex::Regex;
impl Sketch {
/// Create sketch instance from a customized version of AEON model format.
/// The original part of the AEON format (compatible with other biodivine tools) includes:
/// - variable IDs
/// - regulations (and corresponding automatically generated static properties)
/// - update functions and function symbols
/// - layout information
///
/// The custom extension covers most remaining parts of the sketch via model annotations.
/// Currently the annotations are given simpy as
/// #!entity_type: ID: #`json_string`#
/// These annotations either cover additional information (complementing variables and
/// functions), or completely new components like static/dynamic properties and datasets.
///
/// We allow a special case for writing HCTL and FOL properties, compatible with the
/// original BN sketches prototype format:
/// #!static_property: ID: #`fol_formula_string`#
/// #!dynamic_property: ID: #`hctl_formula_string`#
pub fn from_aeon(aeon_str: &str) -> Result<Sketch, String> {
// set psbn info (variables, functions, regulations and corresponding properties)
let bn = BooleanNetwork::try_from(aeon_str)?;
let mut sketch = Sketch::from_boolean_network(&bn)?;
// set layout info
let node_positions = Self::extract_aeon_layout_info(aeon_str);
let default_layout = ModelState::get_default_layout_id();
for (node, x, y) in node_positions {
let node_id = sketch.model.get_var_id(&node)?;
sketch
.model
.update_position(&default_layout, &node_id, x, y)?;
}
// recover the remaining components from aeon model annotations
let aeon_annotations = ModelAnnotation::from_model_string(aeon_str);
let variables = Self::extract_entities(&aeon_annotations, "variable")?;
let functions = Self::extract_entities(&aeon_annotations, "function")?;
let datasets = Self::extract_entities(&aeon_annotations, "dataset")?;
let stat_props = Self::extract_entities(&aeon_annotations, "static_property")?;
let dyn_props = Self::extract_entities(&aeon_annotations, "dynamic_property")?;
// for variables and functions, there can be additional info (like names, annotations, ...)
for (id, variable_str) in variables {
let var_data = VariableData::from_json_str(&variable_str)?;
let var_id = sketch.model.get_var_id(&id)?;
sketch.model.set_raw_var(&var_id, var_data.to_var()?)?;
sketch.model.set_update_fn(&var_id, &var_data.update_fn)?;
}
for (id, fn_str) in functions {
let fn_data = UninterpretedFnData::from_json_str(&fn_str)?;
let fn_id = sketch.model.get_uninterpreted_fn_id(&id)?;
sketch
.model
.set_raw_function(&fn_id, fn_data.to_uninterpreted_fn(&sketch.model)?)?;
}
// datasets have to be added from scratch
for (id, dataset_str) in datasets {
let dataset_data = DatasetData::from_json_str(&dataset_str)?;
sketch
.observations
.add_dataset_by_str(&id, dataset_data.to_dataset()?)?;
}
// properties have to be added from scratch (apart from automatically generated static props)
// we allow two modes - a JSON string for any property, or formula string for HCTL/FOL properties
for (id, content_str) in stat_props {
// try parsing formula
if let Ok(prop) = StatProperty::try_mk_generic(&id, &content_str, "") {
sketch.properties.add_static_by_str(&id, prop)?
} else {
let prop_data = StatPropertyData::from_json_str(&content_str)?;
let property = prop_data.to_property()?;
// ignore automatically generated static props as they were added before
// todo: this can loose some info as standard AEON format does not cover all regulation types
match prop_data.variant {
StatPropertyTypeData::RegulationEssential(..)
| StatPropertyTypeData::RegulationMonotonic(..) => {}
_ => {
sketch.properties.add_static_by_str(&id, property)?;
}
}
}
}
for (id, content_str) in dyn_props {
// try parsing formula
if let Ok(prop) = DynProperty::try_mk_generic(&id, &content_str, "") {
sketch.properties.add_dynamic_by_str(&id, prop)?
} else {
let prop_data = DynPropertyData::from_json_str(&content_str)?;
sketch
.properties
.add_dynamic_by_str(&id, prop_data.to_property()?)?;
}
}
Ok(sketch)
}
/// Create sketch instance from a SBML model format. This variant includes:
/// - variables
/// - regulations (and corresponding automatically generated static properties)
/// - update functions and function symbols
/// - layout information
pub fn from_sbml(sbml_str: &str) -> Result<Sketch, String> {
// set psbn info (variables, functions, regulations and corresponding properties)
let (bn, layout_map) = BooleanNetwork::try_from_sbml(sbml_str)?;
let mut sketch = Sketch::from_boolean_network(&bn)?;
let default_layout = ModelState::get_default_layout_id();
for (node, (px, py)) in layout_map {
let node_id = sketch.model.get_var_id(&node)?;
sketch
.model
.update_position(&default_layout, &node_id, px as f32, py as f32)?;
}
Ok(sketch)
}
/// Create sketch instance from a BooleanNetwork instance of `lib-param-bn`.
/// This includes processing:
/// - variables
/// - regulations (and corresponding automatically generated static properties)
/// - update functions and function symbols
pub fn from_boolean_network(bn: &BooleanNetwork) -> Result<Sketch, String> {
let mut sketch = Sketch::default();
let model = ModelState::from_bn(bn)?;
sketch.model = model;
// correctly set regulation static properties if needed
for reg in sketch.model.regulations() {
let input_var = reg.get_regulator();
let target_var = reg.get_target();
if reg.get_essentiality() != &Essentiality::Unknown {
let prop_id = StatProperty::get_essentiality_prop_id(input_var, target_var);
let prop = mk_essentiality_prop(input_var, target_var, *reg.get_essentiality());
sketch.properties.add_static(prop_id, prop)?;
}
if reg.get_sign() != &Monotonicity::Unknown {
let prop_id = StatProperty::get_monotonicity_prop_id(input_var, target_var);
let prop = mk_monotonicity_prop(input_var, target_var, *reg.get_sign());
sketch.properties.add_static(prop_id, prop)?;
}
}
Ok(sketch)
}
/// Extract positions of nodes from the aeon model string.
/// Positions are expect as lines in forllowing format:
/// #position:NODE_ID:X,Y
///
/// This funtction returns a list of triplets <node_id, x, y>.
fn extract_aeon_layout_info(aeon_str: &str) -> Vec<(String, f32, f32)> {
let re = Regex::new(r"^#position:(\w+):([+-]?\d+(\.\d+)?),([+-]?\d+(\.\d+)?)$").unwrap();
let mut positions = Vec::new();
for line in aeon_str.lines() {
let line = line.trim();
if let Some(captures) = re.captures(line) {
// Extract the NODE_ID, X, and Y values from the captures
let node_id = captures.get(1).unwrap().as_str().to_string();
let x = captures
.get(2)
.unwrap()
.as_str()
.parse::<f32>()
.unwrap_or(0.0);
let y = captures
.get(4)
.unwrap()
.as_str()
.parse::<f32>()
.unwrap_or(0.0);
positions.push((node_id, x, y));
}
}
positions
}
/// Extract list of named entities (tuples with id/content) from an `.aeon` model
/// annotation object.
///
/// The entities are expected to appear as:
/// #!entity_type: ID: #`CONTENT`#
/// So, for example:
/// #!variable:ANT:#`{"id":"ANT","name":"ANT","annotation":"","update_fn":""}`#
///
/// Each list is returned in alphabetic order w.r.t. the entity name.
fn extract_entities(
annotations: &ModelAnnotation,
entity_type: &str,
) -> Result<Vec<(String, String)>, String> {
if let Some(entity_node) = annotations.get_child(&[entity_type]) {
Self::process_entity_node(entity_node, entity_type)
} else {
Ok(Vec::new())
}
}
/// Given a `ModelAnnotation` node corresponding to a particular entity type (like 'variable'),
/// collect all entities of given type from the child nodes.
///
/// This is general for all entity types as annotations share common structure.
/// #!entity_type: ID: #`CONTENT`#
///
/// List is returned in alphabetic order w.r.t. the property name.
fn process_entity_node(
enitity_node: &ModelAnnotation,
enitity_type: &str,
) -> Result<Vec<(String, String)>, String> {
let mut entities = Vec::with_capacity(enitity_node.children().len());
for (id, child) in enitity_node.children() {
if !child.children().is_empty() {
return Err(format!("{enitity_type} `{id}` contains nested values."));
}
let Some(value) = child.value() else {
return Err(format!("Found empty {enitity_type} `{id}`."));
};
if value.lines().count() > 1 {
return Err(format!(
"Found multiple entities of type {enitity_type} with id `{id}`."
));
}
entities.push((id.clone(), value.clone()));
}
// Sort alphabetically to avoid possible non-determinism down the line.
entities.sort_by(|(x, _), (y, _)| x.cmp(y));
Ok(entities)
}
}
impl Sketch {
/// Create sketch instance from a custom JSON model format.
///
/// See [SketchData::from_json_str] for details on the actual parsing.
pub fn from_custom_json(json_str: &str) -> Result<Sketch, String> {
// parse the JSON to intermediate SketchData first
let sketch_data = SketchData::from_json_str(json_str)?;
let sketch = Sketch::new_from_sketch_data(&sketch_data)?;
Ok(sketch)
}
}
#[cfg(test)]
mod tests {
use crate::sketchbook::Sketch;
use std::fs::File;
use std::io::Read;
#[test]
/// Test that importing the same data from different formats results in the same sketch.
/// These models only include PSBN (no additional datasets or properties).
fn basic_import() {
let mut aeon_sketch_file = File::open("../data/test_data/test_model.aeon").unwrap();
let mut json_sketch_file = File::open("../data/test_data/test_model.json").unwrap();
let mut sbml_sketch_file = File::open("../data/test_data/test_model.sbml").unwrap();
let mut aeon_contents = String::new();
aeon_sketch_file.read_to_string(&mut aeon_contents).unwrap();
let mut json_contents = String::new();
json_sketch_file.read_to_string(&mut json_contents).unwrap();
let mut sbml_contents = String::new();
sbml_sketch_file.read_to_string(&mut sbml_contents).unwrap();
let sketch1 = Sketch::from_aeon(&aeon_contents).unwrap();
let sketch2 = Sketch::from_custom_json(&json_contents).unwrap();
let sketch3 = Sketch::from_sbml(&sbml_contents).unwrap();
assert_eq!(sketch1, sketch2);
assert_eq!(sketch2, sketch3);
}
#[test]
/// Test that importing the same data from aeon and json format results in the same sketch.
/// This test involves a full sketch format with datasets and properties.
fn full_import() {
let mut aeon_sketch_file =
File::open("../data/test_data/test_model_with_data.aeon").unwrap();
let mut json_sketch_file =
File::open("../data/test_data/test_model_with_data.json").unwrap();
let mut aeon_contents = String::new();
aeon_sketch_file.read_to_string(&mut aeon_contents).unwrap();
let mut json_contents = String::new();
json_sketch_file.read_to_string(&mut json_contents).unwrap();
let sketch1 = Sketch::from_aeon(&aeon_contents).unwrap();
let sketch2 = Sketch::from_custom_json(&json_contents).unwrap();
assert_eq!(sketch1, sketch2);
}
}