Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/main'
Browse files Browse the repository at this point in the history
  • Loading branch information
yudgugger committed Jun 26, 2024
2 parents 6cbc0c3 + 8c03344 commit 056cf26
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -502,7 +502,7 @@ A default data processing path management is provided, but the user has the opti
</p>

<p align="justify" width="100%">
Following the first processing step (see section <a href="https://github.com/CEA-MetroCarac/PySSPFM/tree/main/doc#iv---first-step-of-data-analysis">IV) - First step of data analysis</a> of the documentation), by default, a new directory is created at the same root as the input data folder, with the nomenclature: <code>'initial_file_name'_'yyyy-mm-dd-HHh-MMm'_out_'processing_type'</code>. This directory itself contains two subdirectories, <code>figs</code> and <code>nanoloops</code>, and a text file, <code>parameters.txt</code>.
Following the first processing step (see section <a href="https://github.com/CEA-MetroCarac/PySSPFM/tree/main/doc#iv---first-step-of-data-analysis">IV) - First step of data analysis</a> of the documentation), by default, a new directory is created at the same root as the input data folder, with the nomenclature: <code>'initial_file_name'_'yyyy-mm-dd-HHh-MMm'_out_'processing_type'</code>. This directory itself contains two subdirectories, <code>figs</code> and <code>nanoloops</code>, a json file, <code>datacube_to_nanoloop_s1_params.json</code> and the csv measurement sheet.
<ul align="justify" width="100%">
<li>Processing parameters for the 1st step are stored in a JSON file named <code>datacube_to_nanoloop_s1_params.json</code>, created with <code>create_json_res</code> or <code>copy_json_res</code> function of the script <code><a href="https://github.com/CEA-MetroCarac/PySSPFM/blob/main/PySSPFM/utils/path_for_runable.py">PySSPFM/utils/path_for_runable.py</a></code></li>
<li>Measurement parameters are contained in the csv measurement sheet that is copied into the result folder</li>
Expand Down Expand Up @@ -531,7 +531,7 @@ Following the second stage of processing (see section <a href="https://github.co
#### III.2.c) - Toolbox

<p align="center" width="100%">
<img align="center" width="50%" src=https://github.com/CEA-MetroCarac/PySSPFM/blob/main/doc/_static/file_management_toolbox.PNG> <br>
<img align="center" width="70%" src=https://github.com/CEA-MetroCarac/PySSPFM/blob/main/doc/_static/file_management_toolbox.PNG> <br>
<em>File management for toolbox scripts</em>
</p>

Expand Down Expand Up @@ -972,7 +972,7 @@ The second step of the process may be initiated either through the <a href="http
</p>

<p align="justify" width="100%">
As an initial step, the <code>nanoloops</code> folder obtained is selected. The entirety of the files within it is arranged using the <code>generate_file_nanoloop_paths</code> function found in the <code><a href="https://github.com/CEA-MetroCarac/PySSPFM/blob/main/PySSPFM/utils/nanoloop_to_hyst/file.py">utils/nanoloop_to_hyst/file.py</a></code> script. Subsequently, data extraction is carried out for each file, employing the <code>extract_nanoloop_data</code> function from the <code><a href="https://github.com/CEA-MetroCarac/PySSPFM/blob/main/PySSPFM/utils/nanoloop/file.py">utils/nanoloop/file.py</a></code>. The measurement and processing parameters from the <code>parameters.txt</code> file are also read and extracted using the <code>print_parameters</code> function within the <code><a href="https://github.com/CEA-MetroCarac/PySSPFM/blob/main/PySSPFM/utils/nanoloop_to_hyst/file.py">utils/nanoloop_to_hyst/file.py</a></code>.
As an initial step, the <code>nanoloops</code> folder obtained is selected. The entirety of the files within it is arranged using the <code>generate_file_nanoloop_paths</code> function found in the <code><a href="https://github.com/CEA-MetroCarac/PySSPFM/blob/main/PySSPFM/utils/nanoloop_to_hyst/file.py">utils/nanoloop_to_hyst/file.py</a></code> script. Subsequently, data extraction is carried out for each file, employing the <code>extract_nanoloop_data</code> function from the <code><a href="https://github.com/CEA-MetroCarac/PySSPFM/blob/main/PySSPFM/utils/nanoloop/file.py">utils/nanoloop/file.py</a></code>. The measurement parameters are read in the csv measurement sheet with the <code>csv_meas_sheet_extract</code> function of the <code><a href="https://github.com/CEA-MetroCarac/PySSPFM/blob/main/PySSPFM/utils/raw_extraction.py">utils/raw_extraction.py</a></code> script.
</p>

<p align="justify" width="100%">
Expand Down

0 comments on commit 056cf26

Please sign in to comment.