Separate requirements in files and folders

[DanicaSTFC]

Describe your changes

• Reduced the requirements to the basic packages, add extra requirements in ui_env.yml file
• Update readme, contributing, documentation

Related Issues

• Closes Separate requirements #440
• Closes Remove QT dependencies from some files #450

Documentation edits:

• edit readme and contributing to make sure the requirements are explained correctly. add an extra env file for the additional packages.
• mention in the readme that the folder for the UI examples requires QT (pyside2)
• add in the contributing that tests need pyside2 and eqt to run locally.
• docker actions need eqt versioning
• mention cil-data in readme

UI folder & ui_eqt_examples depends on

• eqt

• pyside2

• cil-data

• create extra env file for this.

EQT

• Remove dialog from box file, substitute with a warning.
• Remove eqt from env recipe and meta
• check if the CI test_UI_dialogs runs. we added the requirements in the meta - test
• create example folder for ui, check that the test runs. move file opacity_in_viewer in it.

pyside2

• removed from env recipe and meta
• moved example BoxWidgetAroundSlice, FourDockableLinkedViewerWidgets ... in the new folder.
• mention iviewer in readme, a Qt interactive viewer that can be used as plotter2D with one single dataset.
• add docstring to QCILRenderWindowInteractor. this is needed to convert from QT to vtk. we leave it in the same folder. Add description in the file QCILRenderWindowInteractor.
  "A QVTKRenderWindowInteractor for Python and Qt. Uses a vtkGenericRenderWindowInteractor to handle the interactions. Use GetRenderWindow() to get the vtkRenderWindow. Create with the keyword stereo=1 in order to generate a stereo-capable window."
  https://docs.vtk.org/en/latest/api/python/vtkmodules/vtkmodules.qt.QVTKRenderWindowInteractor.html
• mention standalone_viewer in the readme. (this has a main, it is a qt application), we leave it in the same place in the src. we can edit the readme to give less importance to this app. and mention that it is a qapplication.
• test_ui_dialogs, we added the requirements in the meta - test
• test_viewer_main_window, we added the requirements in the meta - test

schema

We leave it in the requirements.
Files in which it appears:

• io.py
• resample.py

h5py

It seems important, we can leave it in the requirements.
Files in which it appears:

• dialogs.py
• hdf5_io.py
• io.py
• examples
• tests

cil-data

• We can remove it from the requirements. Mention that it is needed for examples etc in the readme.
• Add the requirement under test in conda actions.

Files in which it appears:

• docker_build_test_publish
• create_data_folder
• example_data

setuptools

Only needed in the conda build as a fundamental requirements to build with python.

• Remove from environment file

pyyaml

I cannot see it used anywhere. probably used in schema.

importlib_metadata

needed for python 3.7

Describe any testing you have performed

I ran all the examples, and I ran the tests locally as well as passing all the CI tests.

@paskino ran on Windows:

conda create -n viewer_trame python=3.11 numpy matplotlib-base h5py pyyaml schema jupyter -c conda-forge --override-channels
conda activate viewer_trame
pip install vtk # can also install via conda 
# pip install --extra-index-url https://wheels.vtk.org vtk-egl
pip install trame --upgrade
pip install trame-vuetify trame-vtk

I successfully ran viewer2D-without-qt.py and a test with trame and the viewer in jupyter (all experimental code currently not available).

Checklist when you are ready to request a review

• I have performed a self-review of my code
• I have added docstrings in line with the guidance in the CIL developer guide
• I have implemented unit tests that cover any new or modified functionality
• CHANGELOG.md has been updated with any functionality change
• Request review from all relevant developers
• Change pull request label to 'waiting for review'

Contribution Notes

• The content of this Pull Request (the Contribution) is intentionally submitted for inclusion in CILViewer (the Work) under the terms and conditions of the Apache-2.0 License
• I confirm that the contribution does not violate any intellectual property rights of third parties

Qt contributions should follow Qt naming conventions i.e. camelCase method names.

VTK contributions should follow VTK naming conventions i.e. PascalCase method names.