quick refactor and addition of README
This commit is contained in:
parent
3398414b55
commit
c4b0dd1fef
19
README.md
Normal file
19
README.md
Normal file
@ -0,0 +1,19 @@
|
||||
# Ionization Probe Analysis Code
|
||||
|
||||
> Written by Cal Wing (c.wing@uq.net.au - 45811953) in 2024 for his Thesis
|
||||
|
||||
## Installation
|
||||
|
||||
Run `pip install -r requirements.txt` or equivilient for your envoroment.
|
||||
|
||||
## Running
|
||||
|
||||
Run `main.py` it will then generate all the output graphs and put them in (a git untracked) folder called `./images`.
|
||||
|
||||
By default all data graphs will be generated - you need to change the functions called at the end
|
||||
|
||||
## `./data` Explanation
|
||||
|
||||
I like YAML files to store information. All the data shot folders have a file call `_info.yaml` this file contained all the info about the shot so that when it would load & be graphed it would be correct.
|
||||
|
||||
I hope the values are self explanatory but they may not - sorry.
|
32
main.py
32
main.py
@ -29,22 +29,6 @@ CANNY_TIME_OFFSET = 50 #us
|
||||
with open(TUNNEL_INFO_FILE, 'r') as file:
|
||||
TUNNEL_INFO = yaml.safe_load(file)
|
||||
|
||||
data_to_load = [
|
||||
"x2s5823",
|
||||
"x2s5824",
|
||||
"x2s5827",
|
||||
"x2s5829",
|
||||
"x2s5830",
|
||||
"x2s5831",
|
||||
"x2s5832"
|
||||
]
|
||||
|
||||
ref_data_to_load = [
|
||||
"x2s5820",
|
||||
"x2s5821",
|
||||
"x2s5822"
|
||||
]
|
||||
|
||||
# ==== Uncerts ====
|
||||
# Taken from DOI: 10.1007/s00193-017-0763-3 (Implementation of a state-to-state analytical framework for the calculation of expansion tube flow properties)
|
||||
|
||||
@ -1134,6 +1118,22 @@ for refShot in ref_data_to_load:
|
||||
print("Loaded Data")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
data_to_load = [
|
||||
"x2s5823",
|
||||
"x2s5824",
|
||||
"x2s5827",
|
||||
"x2s5829",
|
||||
"x2s5830",
|
||||
"x2s5831",
|
||||
"x2s5832"
|
||||
]
|
||||
|
||||
ref_data_to_load = [
|
||||
"x2s5820",
|
||||
"x2s5821",
|
||||
"x2s5822"
|
||||
]
|
||||
|
||||
print("Graphing Data")
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user