Djalim Simaila
be673c97aa
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.
34 lines
919 B
ReStructuredText
34 lines
919 B
ReStructuredText
Installation
|
|
=====
|
|
|
|
Python Version
|
|
--------------
|
|
Analyse Morphologique is compatible with Python 3.10 and above.
|
|
|
|
|
|
Install Analyse Morphologique
|
|
------------
|
|
|
|
To use Analyse Morphologique, first get a release tarball or clone the repository from `here https://forgemia.inra.fr/scanner3d/analysemorphologique`_.
|
|
Then, install the dependencies with pip:
|
|
|
|
.. code-block:: console
|
|
|
|
$ pip install -r requirements.txt
|
|
|
|
Once the dependencies installed, you can run Analyse Morphologique with
|
|
|
|
.. code-block:: console
|
|
|
|
$ python main.py
|
|
|
|
.. note::
|
|
If you have issues with the pyQt5 module, you can run Analyse Morphologique in a virtual envirenment.
|
|
To do so, run the following commands:
|
|
|
|
.. code-block:: console
|
|
|
|
$ python3 -m venv .venv
|
|
$ source .venv/bin/activate # on Windows, use .venv\Scripts\activate.bat instead
|
|
(.venv) $ pip install -r requirements.txt
|
|
(.venv) $ python main.py |