make it release ready

.gitignore

@@ -3,9 +3,8 @@ __pycache__/
 *.py[cod]
 *$py.class
 
-# C extensions
-# include C extensions for private/PIL
-#*.so
+# C extensions (Uncomment if using private/PIL extensions)
+# *.so
 
 # Distribution / packaging
 .Python
@@ -28,9 +27,8 @@ share/python-wheels/
 *.egg
 MANIFEST
 
-# PyInstaller
-#  Usually these files are written by a python script from a template
-#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+# PyInstaller files
+# These are generated during the build process
 *.manifest
 *.spec
 
@@ -52,79 +50,91 @@ coverage.xml
 .hypothesis/
 .pytest_cache/
 
-# Translations
+# Logs
+*.log
+
+# Translation files
 *.mo
 *.pot
 
-# Django stuff:
+# Database and local settings
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Virtual environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Jupyter Notebook checkpoints
+.ipynb_checkpoints
+
+# IPython configuration and profiles
+profile_default/
+ipython_config.py
+
+# Pyenv files
+.python-version
+
+# Pipenv files
+# Uncomment the next line if Pipfile.lock is not used collaboratively
+# Pipfile.lock
+
+# PEP 582 (Used by tools like PyFlow)
+__pypackages__/
+
+# Django-specific files
 *.log
 local_settings.py
 db.sqlite3
 db.sqlite3-journal
 
-# Flask stuff:
+# Flask-specific files
 instance/
 .webassets-cache
 
-# Scrapy stuff:
+# Scrapy cache
 .scrapy
 
 # Sphinx documentation
 docs/_build/
 
-# PyBuilder
+# PyBuilder target directory
 target/
 
-# Jupyter Notebook
-.ipynb_checkpoints
-
-# IPython
-profile_default/
-ipython_config.py
+# SageMath parsed files
+*.sage.py
 
-# pyenv
-.python-version
+# mkdocs documentation
+/site
 
-# pipenv
-#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
-#   However, in case of collaboration, if having platform-specific dependencies or dependencies
-#   having no cross-platform support, pipenv may install dependencies that don't work, or not
-#   install all needed dependencies.
-#Pipfile.lock
+# mypy type checker cache
+.mypy_cache/
+.dmypy.json
+dmypy.json
 
-# PEP 582; used by e.g. github.com/David-OConnor/pyflow
-__pypackages__/
+# Pyre type checker
+.pyre/
 
-# Celery stuff
+# Celery schedule and PID files
 celerybeat-schedule
 celerybeat.pid
 
-# SageMath parsed files
-*.sage.py
-
-# Environments
-.env
-.venv
-env/
-venv/
-ENV/
-env.bak/
-venv.bak/
-
 # Spyder project settings
 .spyderproject
 .spyproject
 
 # Rope project settings
 .ropeproject
 
-# mkdocs documentation
-/site
-
-# mypy
-.mypy_cache/
-.dmypy.json
-dmypy.json
+# Release folder (for packaging releases)
+release/
 
-# Pyre type checker
-.pyre/
+# Excluded temporary or backup files
+*.tmp
+*~

docs/index.html

@@ -283,7 +283,7 @@ <h2>Welcome to Pizza3 Documentation</h2>
           const markdownContent = `
 # Pizza Modules Documentation
 
-Generated on: **2024-12-11 16:50:48**
+Generated on: **2024-12-11 18:29:15**
 
 <hr style="border: none; height: 1px; background-color: #e0e0e0;" />
 

docs/index_matlab.html

@@ -257,7 +257,7 @@ <h2>Welcome to Pizza3 Matlab Documentation</h2>
 <p>Select a function in the left menu to view its documentation.</p>
 <hr>
 <p><i>When no function is selected, you see this welcome page.</i></p>
-Generated on: 2024-12-11 16:51:18</div>
+Generated on: 2024-12-11 18:29:40</div>
 <div id='Hertz_forces' class='doc-content' style='display: none;'>
 <h1>Code to explain the displacement of SPH particles (amorphous) along a rigid wall made with beads of the same size (organized)</h1>
 <p>INRAE\Olivier Vitrac, Han Chen - 2023-02-23</p>

docs/pizza_classes_documentation.md

@@ -1,6 +1,6 @@
 # Pizza Modules Documentation
 
-Generated on: **2024-12-11 16:50:48**
+Generated on: **2024-12-11 18:29:15**
 
 <hr style="border: none; height: 1px; background-color: #e0e0e0;" />