search

PMEAL / OpenPNM

A Python package for performing pore network modeling of porous media
http://openpnm.org
MIT License
450 stars 174 forks source link

Remove the IO folder #21

Closed jgostick closed 11 years ago

jgostick commented 11 years ago

I think the IO folder is redundant. I think that the VTK functions should be moved to Visualization, and the network import function should be in Generators. Generating a network object by importing the data is still generating. And VTK under visualization seems obvious.

I think @jhinebau should do this since these are both his functions.

jhinebau commented 11 years ago

I agree that the VTK function can be moved to Visualization (although, it does "save" the pore network in a file format); however, I think that the IO folder could remain, and we should talk about this in our next meeting.

The ImportMat function was written to be a generic tool, that interfaces with the dictionary imported when scipy.io.loadmat is used. I have yet to write the Generators function that builds a useable pore network from a mat file, but it will use the ImportMat function to access the variables in the mat file.

I imagine we'll have several functions that save or read in network states, that we'll want to house in IO, unless we somehow build these functions into the GenericNetwork class.

jgostick commented 11 years ago

I still think that importing is philosophically/technically equivalent to generating a network so should be moved there.

Saving networks should be the job of the Base class, which I was tempted to call Utilities last night when I was renaming. It already has the pickle function.

IO is ambiguous.

jhinebau commented 11 years ago

This folder is being removed. NetToVtp is moving to Visualization. ImportMat is moving to Utilities (renamed Base)