The Sphinx documentation has been added to the project. This includes a Makefile, a make.bat file, and a conf.py file in the docs directory. The source directory contains the documentation files in reStructuredText format. The documentation includes an installation guide and an API reference. The utils package has been reorganized to be more modular and easier to document. The documentation can be built using the `make html` command in the docs directory.
🎉 feat(utils): add new modules and packages to the project
New modules and packages have been added to the project. The following packages have been added:
- utils.gui.pyqt.about
- utils.gui.pyqt.error_popup
- utils.gui.pyqt.main_window
- utils.gui.pyqt.settings
- utils.math
- utils.settings
The new packages contain modules that provide additional functionality to the project.
32 lines
763 B
Python
32 lines
763 B
Python
"""
|
|
Created on Fri Apr 21 2023
|
|
@name: mpl_render.py
|
|
@desc: A module to render a 2D data using matplotlib, thoses functions cant be integrated into pyqt gui yet
|
|
@auth: Djalim Simaila
|
|
@e-mail: djalim.simaila@inrae.fr
|
|
"""
|
|
|
|
import matplotlib.pyplot as plt
|
|
|
|
def render2D(values:list):
|
|
"""
|
|
Render a 2D model using matplotlib
|
|
|
|
:param values: A list with the values
|
|
"""
|
|
fig = plt.figure()
|
|
ax = fig.add_subplot()
|
|
ax.plot(values)
|
|
plt.show()
|
|
|
|
def cross_section(x_values:list, y_values:list):
|
|
"""
|
|
Render a 2D cross section using matplotlib
|
|
|
|
:param x: A list with the x values
|
|
:param y: A list with the y values
|
|
"""
|
|
fig = plt.figure()
|
|
ax = fig.add_subplot()
|
|
ax.scatter(x_values,y_values)
|
|
plt.show() |