Ciw icon indicating copy to clipboard operation
Ciw copied to clipboard

Recommended practices for model configuration storage

Open galenseilis opened this issue 2 years ago • 1 comments

I am thinking about how to develop and maintain model configurations.

  • I could use ciw.create_network to develop an instance of the ciw.network class and then serialize it.
  • I could keep that configuration information in a format such as XML or JSON.
  • Or something else?

Whichever way I would want to keep things in a versioning system (git).

galenseilis avatar Oct 30 '23 02:10 galenseilis

We used to have .yml files for this, however it got much more complicated when some inputs were functions or objects, and it got a bit messy when combining with numpy arrays.

I find that the Python file itself if sufficient, as the inputs to ciw.create_network are so readable.

I would recommend keeping models as separate Python files creating the networks, and just importing them into the main script.

geraintpalmer avatar Apr 04 '24 14:04 geraintpalmer