Skip to content

Commit 86b387a

Browse files
support csv for loadsave, fix catlab compat
- it is possible to import/export networks using csv format; solves #6 - fix acset access (catlab update) - up catlab compat
1 parent e69b98b commit 86b387a

21 files changed

+176
-80
lines changed

Project.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
3434

3535
[compat]
3636
CSV = "0.10"
37-
Catlab = "0.14"
37+
Catlab = "0.14.13"
3838
ComponentArrays = "0.13"
3939
Crayons = "4.1"
4040
DataFrames = "1.4"

docs/build/index.html

Lines changed: 6 additions & 4 deletions
Large diffs are not rendered by default.

docs/build/search.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
<!DOCTYPE html>
2-
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Search · ReactiveDynamics.jl API Documentation</title><script data-outdated-warner src="assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.045/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.24/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="assets/documenter.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="index.html">ReactiveDynamics.jl API Documentation</a></span></div><form class="docs-search" action="search.html"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="index.html">API Documentation</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href="search.html">Search</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href="search.html">Search</a></li></ul></nav><div class="docs-right"><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article><p id="documenter-search-info">Loading search...</p><ul id="documenter-search-results"></ul></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.23 on <span class="colophon-date" title="Monday 23 January 2023 00:02">Monday 23 January 2023</span>. Using Julia version 1.8.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body><script src="search_index.js"></script><script src="assets/search.js"></script></html>
2+
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Search · ReactiveDynamics.jl API Documentation</title><script data-outdated-warner src="assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.045/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.24/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="assets/documenter.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="index.html">ReactiveDynamics.jl API Documentation</a></span></div><form class="docs-search" action="search.html"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="index.html">API Documentation</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href="search.html">Search</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href="search.html">Search</a></li></ul></nav><div class="docs-right"><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article><p id="documenter-search-info">Loading search...</p><ul id="documenter-search-results"></ul></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.24 on <span class="colophon-date" title="Tuesday 31 January 2023 00:47">Tuesday 31 January 2023</span>. Using Julia version 1.8.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body><script src="search_index.js"></script><script src="assets/search.js"></script></html>

docs/build/search_index.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/src/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,15 +67,15 @@ For deterministic "rates", use `@per_step(ex)`. Here, `ex` evaluates to a determ
6767

6868
## Model import and export
6969
```@docs
70-
@import_model
71-
@export_model
70+
@import_network
71+
@export_network
7272
```
7373

7474
## Solution import and export
7575
```@docs
7676
@import_solution
77-
@export_as_table
78-
@export_csv
77+
@export_solution_as_table
78+
@export_solution_as_csv
7979
@export_solution
8080
```
8181

src/ReactiveDynamics.jl

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -69,12 +69,15 @@ const ReactionNetwork = FoldedReactionNetworkType{Symbol, Union{String, Symbol,
6969
FoldedObservable, Any}
7070

7171
Base.convert(::Type{Symbol}, ex::String) = Symbol(ex)
72-
Base.convert(::Type{Union{String, Symbol, Missing}}, ex::String) =
72+
73+
function Base.convert(::Type{Union{String, Symbol, Missing}}, ex::String)
7374
try
7475
Symbol(ex)
7576
catch
7677
string(ex)
7778
end
79+
end
80+
7881
Base.convert(::Type{SampleableValues}, ex::String) = MacroTools.striplines(Meta.parse(ex))
7982
Base.convert(::Type{Set{Symbol}}, ex::String) = eval(Meta.parse(ex))
8083
Base.convert(::Type{FoldedObservable}, ex::String) = eval(Meta.parse(ex))
@@ -107,14 +110,14 @@ species_modalities = [:nonblock, :conserved, :rate]
107110
function assign_defaults!(acs::ReactionNetwork)
108111
for (_, v_) in defargs, (k, v) in v_
109112
for i in 1:length(subpart(acs, k))
110-
!isassigned(subpart(acs, k), i) && (subpart(acs, k)[i] = v)
113+
isnothing(acs[i, k]) && (subpart(acs, k)[i] = v)
111114
end
112115
end
113116

114-
foreach(i -> isassigned(subpart(acs, :specModality), i) ||
117+
foreach(i -> !isnothing(acs[i, :specModality]) ||
115118
(subpart(acs, :specModality)[i] = Set{Symbol}()), 1:nparts(acs, :S))
116119
k = [:specCost, :specReward, :specValuation]
117-
foreach(k -> foreach(i -> isassigned(subpart(acs, k), i) || (subpart(acs, k)[i] = 0.0),
120+
foreach(k -> foreach(i -> !isnothing(acs[i, k]) || (subpart(acs, k)[i] = 0.0),
118121
1:nparts(acs, :S)), k)
119122

120123
acs
@@ -123,6 +126,7 @@ end
123126
function ReactionNetwork(transitions, reactants, obs, events)
124127
merge_acs!(ReactionNetwork(), transitions, reactants, obs, events)
125128
end
129+
126130
function ReactionNetwork(transitions, reactants, obs)
127131
merge_acs!(ReactionNetwork(), transitions, reactants, obs, [])
128132
end
@@ -170,9 +174,4 @@ include("solvers.jl")
170174
include("optim.jl")
171175
include("loadsave.jl")
172176

173-
# Catlab.jl hack: bypass @isdefined check
174-
function Base.getindex(m::Catlab.ColumnImplementations.PartialVecMap, x::Int)
175-
m.v[x]
176-
end
177-
178177
end

src/compilers.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ function remove_choose(acs::ReactionNetwork)
145145
pcs = []
146146
for attr in propertynames(acs.subparts)
147147
attrs_ = subpart(acs, attr)
148-
foreach(i -> isassigned(attrs_, i) && attrs_[i] isa Expr &&
148+
foreach(i -> !isnothing(attrs_[i]) && attrs_[i] isa Expr &&
149149
(attrs_[i] = normalize_pcs!(pcs, attrs_[i])), 1:length(attrs_))
150150
end
151151

src/interface/update.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ end
7676
function incident_pattern(pattern, attr)
7777
ix = []
7878
for i in 1:length(attr)
79-
isassigned(attr, i) &&
79+
!isnothing(attr[i]) &&
8080
(m = match(pattern, string(attr[i]));
8181
!isnothing(m) &&
8282
(string(attr[i]) == m.match)) && push!(ix, i)
@@ -94,7 +94,7 @@ function mode!(acs, dict)
9494
end
9595

9696
for ix in i
97-
!isassigned(subpart(acs, specModality), ix) &&
97+
isnothing(acs[ix, specModality]) &&
9898
(acs[ix, specModality] = Set{Symbol}())
9999
union!(acs[ix, :specModality], mods)
100100
end

src/loadsave.jl

Lines changed: 97 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,104 +1,160 @@
1-
export @import_model, @export_model
1+
export @import_network, @export_network
2+
export @load_models
23
export @import_solution, @export_solution
3-
export @export_as_table, @export_csv
4+
export @export_solution_as_table, @export_solution_as_csv
45
export @export, @import
56

67
using TOML, JLD2, CSV
78
using DataFrames
89

910
const objects_aliases = Dict(:S => "spec", :T => "trans", :P => "prm", :M => "meta",
1011
:E => "event", :obs => "obs")
12+
1113
const RN_attrs = string.(propertynames(ReactionNetwork().subparts))
1214

1315
function get_attrs(object)
14-
(object = object isa Symbol ? objects_aliases[object] : object;
15-
filter(x -> occursin(object,
16-
x),
17-
RN_attrs))
16+
object = object isa Symbol ? objects_aliases[object] : object
17+
18+
filter(x -> occursin(object, x), RN_attrs)
1819
end
1920

20-
function serialize_to_toml(acs::ReactionNetwork, io::IO = stdout)
21-
data = Dict()
21+
function export_network(acs::ReactionNetwork)
22+
dict = Dict()
2223
for (key, val) in objects_aliases
23-
push!(data, val => [])
24+
push!(dict, val => [])
2425
for i in 1:nparts(acs, key)
25-
data_ = Dict()
26+
dict_ = Dict()
2627
for attr in get_attrs(val)
2728
attr_val = acs[i, Symbol(attr)]
2829
ismissing(attr_val) && continue
2930
attr_val = attr_val isa Number ? attr_val : string(attr_val)
30-
push!(data_, string(attr) => attr_val)
31+
push!(dict_, string(attr) => attr_val)
3132
end
32-
push!(data[val], data_)
33+
push!(dict[val], dict_)
3334
end
3435
end
3536

36-
TOML.print(io, data)
37+
dict
3738
end
3839

39-
function deserialize_from_dict(data::Dict)
40+
function load_network(dict::Dict)
4041
acs = ReactionNetwork()
4142
for (key, val) in objects_aliases
42-
for row in data[val]
43+
val == "prm" && continue
44+
for row in get(dict, val, [])
4345
i = add_part!(acs, key)
4446
for (attr, attrval) in row
4547
set_subpart!(acs, i, Symbol(attr), attrval)
4648
end
4749
end
4850
end
4951

50-
for row in get(data, "registered", [])
52+
for row in get(dict, "prm", [])
53+
i = add_part!(acs, :P)
54+
for (attr, attrval) in row
55+
if attr == "prmVal"
56+
attrval = attrval isa String ? eval(Meta.parseall(attrval)) : attrval
57+
end
58+
set_subpart!(acs, i, Symbol(attr), attrval)
59+
end
60+
end
61+
62+
for row in get(dict, "registered", [])
5163
eval(Meta.parseall(row["body"]))
5264
end
5365

5466
assign_defaults!(acs)
5567
end
5668

57-
export_model(acs::ReactionNetwork, path::AbstractString) =
58-
open(path, "w") do io
59-
serialize_to_toml(acs, io)
69+
function import_network_csv(pathmap)
70+
dict = Dict(); for (key, paths) in pathmap
71+
push!(dict, key => [])
72+
for path in paths
73+
data = DataFrame(CSV.File(path; delim=";;", types=String, stripwhitespace=true, comment="#"))
74+
for row in eachrow(data)
75+
object = Dict(); for (attr, val) in Iterators.zip(keys(row), values(row))
76+
!ismissing(val) && push!(object, string(attr) => val)
77+
end
78+
push!(dict[key], object)
79+
end
80+
end
81+
end
82+
83+
load_network(dict)
84+
end
85+
86+
function import_network(path::AbstractString)
87+
if splitext(path)[2] == ".csv"
88+
pathmap = Dict(val => [] for val in [collect(values(objects_aliases)); "registered"])
89+
for row in CSV.File(path; delim=";;", stripwhitespace=true, comment="#")
90+
push!(pathmap[row.type], joinpath(dirname(path), row.path))
91+
end
92+
93+
import_network_csv(pathmap)
94+
else
95+
load_network(TOML.parsefile(path))
6096
end
61-
function import_model(path::AbstractString)
62-
(dict = TOML.parsefile(path); deserialize_from_dict(dict))
6397
end
6498

65-
function load_models(io::IO)
66-
for line in eachline(io)
67-
name, path = split(line, ';')
68-
name = isempty(name) ? gensym() : name
99+
100+
function export_network(acs::ReactionNetwork, path::AbstractString)
101+
if splitext(path)[2] == ".csv"
102+
exported_network = export_network(acs)
103+
paths = DataFrame(type = [], path = [])
104+
for (key, objs) in exported_network
105+
push!(paths, (key, "export-$key.csv"))
106+
objs_exported = DataFrame(Dict(attr => [] for attr in get_attrs(key)))
107+
for obj in objs
108+
push!(objs_exported, [get(obj, key, missing) for key in names(objs_exported)])
109+
end
110+
111+
CSV.write(joinpath(dirname(path), "export-$key.csv"), objs_exported, delim=";;")
112+
end
113+
CSV.write(path, paths, delim=";;")
114+
else
115+
open(io -> TOML.print(io, export_network(acs)), path, "w+")
69116
end
70117
end
71118

119+
72120
"""
73-
Export model to a file.
121+
Export model to a file: this can be either a single TOML file encoding the entire model,
122+
or a batch of CSV files (a root file and a number of files, each per a class of objects).
123+
124+
See `tutorials/loadsave` for an example.
74125
75126
# Examples
76127
```julia
77-
@export_model acs "acs_data.toml"
128+
@export_network acs "acs_data.toml" # as a TOML
129+
@export_network acs "csv/model.csv" # as a CSV
78130
```
79131
"""
80-
macro export_model(acsex, pathex)
81-
:(export_model($(esc(acsex)), $(string(pathex))))
132+
macro export_network(acsex, pathex)
133+
:(export_network($(esc(acsex)), $(string(pathex))))
82134
end
83135

84136
"""
85-
Import a model from a file.
137+
Import a model from a file: this can be either a single TOML file encoding the entire model,
138+
or a batch of CSV files (a root file and a number of files, each per a class of objects).
139+
140+
See `tutorials/loadsave` for an example.
86141
87142
# Examples
88143
```julia
89-
@import_model "model.toml"
144+
@import_network "model.toml"
145+
@import_network "csv/model.toml"
90146
```
91147
"""
92-
macro import_model(pathex, name = gensym())
93-
:($(esc(name)) = import_model($(string(pathex))))
148+
macro import_network(pathex, name = gensym())
149+
:($(esc(name)) = import_network($(string(pathex))))
94150
end
95151

96152
macro load_models(pathex)
97153
callex = :(begin end)
98154
for line in readlines(string(pathex))
99155
name, pathex = split(line, ';')
100156
name = isempty(name) ? gensym() : Symbol(name)
101-
push!(callex.args, :($(esc(name)) = import_model($(string(pathex)))))
157+
push!(callex.args, :($(esc(name)) = import_network($(string(pathex)))))
102158
end
103159

104160
callex
@@ -133,30 +189,30 @@ macro export_solution(solex, pathex = "sol.jld2")
133189
end
134190

135191
"""
136-
@export_as_table sol
192+
@export_solution_as_table sol
137193
Export a solution as a `DataFrame`.
138194
139195
# Examples
140196
```julia
141-
@export_as_table sol
197+
@export_solution_as_table sol
142198
```
143199
"""
144-
macro export_as_table(solex, pathex = "sol.jld2")
200+
macro export_solution_as_table(solex, pathex = "sol.jld2")
145201
:(DataFrame($(esc(solex))))
146202
end
147203

148204
get_DataFrame(sol) = sol isa EnsembleSolution ? DataFrame(sol)[!, [:u, :t]] : DataFrame(sol)
149205

150206
"""
151-
@export_csv sol
152-
@export_csv sol "sol.csv"
207+
@export_solution_as_csv sol
208+
@export_solution_as_csv sol "sol.csv"
153209
Export a solution to a file.
154210
155211
# Examples
156212
```julia
157-
@export_csv sol "sol.csv"
213+
@export_solution_as_csv sol "sol.csv"
158214
```
159215
"""
160-
macro export_csv(solex, pathex = "sol.csv")
216+
macro export_solution_as_csv(solex, pathex = "sol.csv")
161217
:(CSV.write($(string(pathex)), get_DataFrame($(esc(solex)))))
162218
end

src/macros_overview/macros.mmd

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ flowchart TD
44
@name_transition, @optimize, @periodic, @prob_check_verbose,
55
@prob_init, @prob_meta, @prob_params, @prob_uncertainty,
66
@push, @reward, @valuation"| acs
7-
sol --> |"@export_as_table"| table["table"]
8-
sol --> |"@export_csv"| csvsol["sol.csv"]
9-
acs --> |"@export_model"| mod["model.toml"]
7+
sol --> |"@export_solution_as_table"| table["table"]
8+
sol --> |"@export_solution_as_csv"| csvsol["sol.csv"]
9+
acs --> |"@import_network"| mod["model.toml"]
1010
sol--> |"@export_solution"| solex["sol.jld2"]
1111
joinsol --> |"@fit_and_plot"| plot
12-
mod --> |"@import_model"| acs
12+
mod --> |"@export_network"| acs
1313
solex --> |"@import_solution"| sol["solution"]
1414
acs1["ACS1\n~ReactiveDynamics.ReactionNetwork"] --- join[ ]
1515
acs2["ACS2\n~ReactiveDynamics.ReactionNetwork"] --- join[ ]

0 commit comments

Comments
 (0)