Skip to content

Update installation instructions for PCT#69

Merged
SimonRit merged 1 commit into
RTKConsortium:mainfrom
tbaudier:patch-1
Jun 11, 2026
Merged

Update installation instructions for PCT#69
SimonRit merged 1 commit into
RTKConsortium:mainfrom
tbaudier:patch-1

Conversation

@tbaudier

Copy link
Copy Markdown
Contributor

Added instructions for creating a Python virtual environment and compiling PCT to have python wrapping

@SimonRit SimonRit left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot @tbaudier. I'm not so sure we should use indicate make install in this documentation. What was the motivation?
Note that the commit message must be edited, a DOC: prefix is missing. See
https://docs.itk.org/en/latest/contributing/index.html
(we follow ITK guidelines as it is an ITK module).

Comment thread documentation/docs/installation.md Outdated
Comment thread documentation/docs/installation.md Outdated
Comment thread documentation/docs/installation.md Outdated
Comment thread documentation/docs/installation.md Outdated
```

ITK uses [CMake](https://cmake.org) as its building tool. Below is an example of how to configure ITK, but feel free to edit the options as needed.
ITK uses [CMake](https://cmake.org) as its building tool. Below is an example of how to configure ITK, but feel free to edit the options as needed (works with ITK v6.0a1).

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would remove this added reference to ITK v6.0a1 which will soon be outdated.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did not succeed to compile RTK with ITK v6.0a2

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't want to support ITK alpha versions and even less indicate versions numbers in the documentation. So it's either main branches for all modules or latest release (ITK v5.4.5). @axel-grc can you please clarify the status of the RTK main and v2.7.0 compilation against ITK main, ITK v5.4.5 and ITK v6.0b02? Thanks, for the record the list of ITK tags:
https://github.com/InsightSoftwareConsortium/ITK/tags

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's been many ITK releases tagged since this change (as expected). PCT should be compatible with the main and release branches and the latest v5.4.6 release. I suggest removing this change and working on making sure PCT is up-to-date with these branches and tag (possibly separately from this PR).

Comment thread documentation/docs/installation.md Outdated
Comment thread documentation/docs/installation.md Outdated
Comment thread documentation/docs/installation.md
@acoussat acoussat self-assigned this Apr 29, 2026
@acoussat

acoussat commented Jun 9, 2026

Copy link
Copy Markdown
Collaborator

I have implemented @SimonRit's comments and marked as resolved the related comments. I have created a separate commit for easier reviewing but of course I will squash them together before merging. Only two comments are left open, I'm not sure what to do with them?

@SimonRit SimonRit left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can be merged once the reference to an outdated ITK release has been removed. Thanks!

Added instructions for creating a Python virtual environment and compiling PCT to have python wrapping
@SimonRit SimonRit merged commit 162b39e into RTKConsortium:main Jun 11, 2026
14 checks passed
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.

3 participants