Skip to content

Commit 0d2cc1d

Browse files
authored
Update README.md
1 parent 393e124 commit 0d2cc1d

1 file changed

Lines changed: 45 additions & 14 deletions

File tree

README.md

Lines changed: 45 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -44,20 +44,7 @@ Then you can run the tests.
4444
python3 -m unittest
4545
```
4646

47-
### Running on test data
48-
49-
Once the tests have completed, you can try out the program on the downloaded test data.
50-
51-
Instead of running on all wells (which takes about an hour to complete), we'll run on just two wells:
52-
```
53-
pcpostprocess run_herg_qc ./tests/test_data/13112023_MW2_FF/ -w A02 A03
54-
```
55-
56-
This will create several quality control plots in the directory `output`, and take XXX to XXX minutes to complete.
57-
For every well, a ??? plot will be created, showing ???.
58-
59-
60-
## Detailed usage
47+
## Usage
6148

6249
### Running QC and post-processing
6350

@@ -126,3 +113,47 @@ options:
126113
--log_level LOG_LEVEL
127114
```
128115
116+
## Example: Running on test data
117+
118+
Once the tests have completed, you can try out the program on the downloaded test data.
119+
120+
Instead of running on all wells (which takes about an hour to complete), we'll run on just two wells:
121+
```
122+
pcpostprocess run_herg_qc ./tests/test_data/13112023_MW2_FF/ -w A02 A03
123+
```
124+
This should take around 5 minutes to run, and produce the following output
125+
output
126+
|- hergqc
127+
|- 13112023_MW2-staircaseramp_2-leak_fit-after
128+
|- 13112023_MW2-staircaseramp_2-leak_fit-before
129+
|- 13112023_MW2-staircaseramp-leak_fit-after
130+
|- 13112023_MW2-staircaseramp-leak_fit-before
131+
|- debug
132+
|- leak_correction
133+
|- output
134+
|- reversal_plots
135+
|- subtraction_plots
136+
|- traces
137+
|- A02-sweep0-after.png
138+
|- A02-sweep0-before.png
139+
|- A02-sweep1-after.png
140+
|- A02-sweep1-before.png
141+
|- A03-sweep0-after.png
142+
|- A03-sweep0-before.png
143+
|- A03-sweep1-after.png
144+
|- A03-sweep1-before.png
145+
|- chrono.txt
146+
|- info.txt
147+
|- passed_wells.txt
148+
|- QC-13112023_MW2.csv
149+
|- QC-13112023_MW2.json
150+
|- qc_table.tex
151+
|- qc_table.xlsx
152+
|- qc_vals_df.csv
153+
|- selected-13112023_MW2.txt
154+
|- selected-13112023_MW2-staircaseramp.txt
155+
|- selected-13112023_MW2-staircaseramp_2.txt
156+
|- subtraction_qc.csv
157+
```
158+
159+
Here ...

0 commit comments

Comments
 (0)