Skip to content

Commit

Permalink
Merge branch 'dll' of https://github.com/modsim/CADET-Python into dll
Browse files Browse the repository at this point in the history
  • Loading branch information
Immudzen committed Jun 8, 2021
2 parents de0875b + 79fe41d commit 9c9494f
Showing 1 changed file with 12 additions and 11 deletions.
23 changes: 12 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,26 @@
CADET python is a file based python interface for CADET
CADET still must be downloaded and built from https://github.com/modsim/CADET
CADET-Python is a file based Python interface for CADET. CADET must be downloaded from:

CADET python almost exactly maps to the documented CADET interface except that all dataset names
are lowercase. This simplifies useing the interface.
https://github.com/modsim/CADET

This package includes the Cadet class and H5 class. H5 can be used as a simple generic HDF5 interface.
CADET-Python almost exactly maps to the documented CADET interface except that all dataset names are lowercase. This simplifies useing the interface.

This package includes the CADET class and H5 class. H5 can be used as a simple generic HDF5 interface.

As an example look at setting column porosity for column 1. From the CADET manual, the path for this is:

As an example look at setting column porosity for column 1. From the CADET manual the path for this is
/input/model/unit_001/COL_POROSITY

In the python interface this becomes
In the Python interface this becomes:

sim = Cadet()
sim.root.input.model.unit_001.col_porosity = 0.33

Once the simulation has been created it must be saved before it can be run
Once the simulation has been created it must be saved before it can be run.

sim.filename = "/path/to/where/you/want/the/file.hdf5"
sim.save()

#Next the path to cadet needs to be set before a simulation can be run, if running on windows you need the path to cadet-cli.exe
#next the path to CADET needs to be set before a simulation can be run. If running on Microsoft Windows you need the path to cadet-cli.exe

sim.cadet_path = '/path/to/cadet-cli'

Expand All @@ -31,9 +32,9 @@ print(sim.run())
sim.load()


At this point any data can be read
At this point any data can be read.

If you have a file you want to read that has already been simulated this is also easy to do
If you have a file you want to read that has already been simulated this is also easy to do.

sim = Cadet()
sim.filename = "/path/to/where/you/want/the/file.hdf5"
Expand Down

0 comments on commit 9c9494f

Please sign in to comment.