Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Separate requirements in files and folders #451

Draft
wants to merge 16 commits into
base: master
Choose a base branch
from

Conversation

DanicaSTFC
Copy link
Collaborator

@DanicaSTFC DanicaSTFC commented Jan 22, 2025

Describe your changes

Closes #440 #450

  • edit readme and contributing to make sure the requirements are explained correctly. perhaps add an env file.
  • say in the readme that there is a separate folder for the UI examples, requiring QT (pyside2)
  • add in the contributing that tests need pyside2 and eqt to run locally.
  • docker actions will need eqt versioning
  • mention cil-data in readme

UI folder & ui_eqt_examples depends on

  • eqt
  • pyside2
  • h5py
  • cil-data

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 eqt, 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.
  • iviewer, a Qt interactive viewer that can be used as plotter2D with one single dataset.
  • QCILRenderWindowInteractor, 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
  • standalone_viewer (this has a main, it is a qt application), we leave it in the same place. we can edit the readme to give less importance to this app. and mention that it is an application.
  • 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.
  • Remove test_example_data from the 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

Consider adding example code to examples

Link relevant issues

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.

@DanicaSTFC DanicaSTFC changed the title Remove eqt dependencies Separate requirements in files and folders Jan 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Separate requirements
1 participant