From 2f08533edbaf581df64f5440e0e1ab73bd742019 Mon Sep 17 00:00:00 2001 From: Eric von Lieres Date: Thu, 18 Feb 2021 15:46:11 +0100 Subject: [PATCH 1/2] Update README.md --- README.md | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 7a94af4..e79347d 100644 --- a/README.md +++ b/README.md @@ -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' @@ -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" From 79fe41df4ae6fcc2d1331f3f1db614145a6bf206 Mon Sep 17 00:00:00 2001 From: Eric von Lieres Date: Thu, 18 Feb 2021 15:46:50 +0100 Subject: [PATCH 2/2] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e79347d..2afc3a5 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ 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 Microsoft 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'