Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
yudgugger committed May 7, 2024
1 parent 7c2504c commit 13b853d
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2058,6 +2058,7 @@ A second json file, <code><a href="https://github.com/CEA-MetroCarac/PySSPFM/blo
<p align="justify" width="100%">
The entire assemblage of scripts under the <code><a href="https://github.com/CEA-MetroCarac/PySSPFM/tree/main/PySSPFM/utils/core">core</a></code> umbrella comprises functions that are relatively generic and form the foundation for most of the PySSPFM application scripts. These scripts encompass: <br>
&#8226 <code><a href="https://github.com/CEA-MetroCarac/PySSPFM/blob/main/PySSPFM/utils/core/basic_func.py">basic_func.py</a></code>, which houses a collection of algebraic models on which the performed fits rely. <br>
&#8226 <code><a href="https://github.com/CEA-MetroCarac/PySSPFM/blob/main/PySSPFM/utils/core/clustering.py">clustering.py</a></code>, which contains all the functions necessary for clustering on loops or curves, specifically <code>curve_clustering</code> function, which can be used with K-Means or Gaussian Mixture Model (GMM) method. <br>
&#8226 <code><a href="https://github.com/CEA-MetroCarac/PySSPFM/blob/main/PySSPFM/utils/core/curve_hysteresis.py">curve_hysteresis.py</a></code>, responsible for initializing and processing the <code>Hysteresis</code> object (refer to Section <a href="https://github.com/CEA-MetroCarac/PySSPFM/blob/main/doc/README.md#vi3---hysteresis-and-properties">IV.3) - Hysteresis and properties</a> in the documentation). <br>
&#8226 <code><a href="https://github.com/CEA-MetroCarac/PySSPFM/blob/main/PySSPFM/utils/core/extract_params_from_file.py">extract_params_from_file.py</a></code>, which allows to extract settings or parameters from a json or toml file, with the <code>load_parameters_from_file</code> function. If the installation of the <a href="https://pypi.org/project/toml/">toml</a> library requisite for reading a toml file is not perfomed, <code>TomlError</code> object is raised (in the case of a toml file reading). <br>
&#8226 <code><a href="https://github.com/CEA-MetroCarac/PySSPFM/blob/main/PySSPFM/utils/core/figure.py">figure.py</a></code>, which facilitates the generation of visual representations in a consistent style. This encompasses the creation of graphs, histograms, and mappings through the functions <code>plot_graph</code>, <code>plot_hist</code>, and <code>plot_map</code>. The <code>print_plots</code> function offers advanced control over the display and storage of visual representations. <br>
Expand Down

0 comments on commit 13b853d

Please sign in to comment.