Add README
authorLukas Jiriste <ljiriste@student.42prague.com>
Mon, 17 Jun 2024 13:04:38 +0000 (15:04 +0200)
committerLukas Jiriste <ljiriste@student.42prague.com>
Mon, 17 Jun 2024 13:04:38 +0000 (15:04 +0200)
The README contains info about the program function but it also holds
some authorship information. I really should include some license
but I am not in a position to decide what license to use now
and just want to add the code for myself to work on.

README [new file with mode: 0644]

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..fb36263
--- /dev/null
+++ b/README
@@ -0,0 +1,40 @@
+This project was created for processing data from an experimental cell.
+The cell looks like this:
+
+                 input
+
+                   ||
+                   ||
+                   ||
+                                  \/
+-------------------------------------------
+|                                         |
+|                                         |
+|                  V1                     |
+|                                         |
+|                                         |
+-------------------------------------------
+|                                         |
+|                                         |
+|                  V2                     |
+|                                         |
+|                                         |
+-------------------------------------------
+
+The cell has 2 volumes (V1, V2) separated by a membrane.
+The experiment starts with both volumes evacuated. A valve on the input is
+then opened and closed as fast as possible. This lets some gas inside,
+which then starts to permeate through the membrane. The rate of pressure
+equilibration between V1 and V2 holds the information of permeability
+of the membrane to the gas used. The equilibrium pressure holds the
+information about the sorption characteristics. The diffusion coeficient
+can then be calculated from these, but is also encrypted in the pressure
+time evolution.
+
+This program processes the pressure measurements from V1 and V2 to give
+the the permeability, diffusion coeficient, and sorption of the membrane.
+
+The author of the idea is Petr Uchytil. The realization was worked on
+by Petr Uchytil, Roman Petričkovič, Kateřina Setničková and Lukáš Jiřiště.
+
+This software was written by Lukáš Jiřiště.