Skip to content

Commit

Permalink
Merge pull request InsightSoftwareConsortium#4288 from thewtex/downlo…
Browse files Browse the repository at this point in the history
…ad-page-releases

Download page releases
  • Loading branch information
thewtex authored Nov 6, 2023
2 parents 7f3f616 + cd5dfad commit 497bfda
Show file tree
Hide file tree
Showing 10 changed files with 113 additions and 146 deletions.
2 changes: 1 addition & 1 deletion .gitattributes
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Modules/ThirdParty/** hooks-max-size=300000 hooks.style=
Modules/ThirdParty/NIFTI/src/nifti/nifti2/nifti2_io.c hooks-max-size=400000
Modules/ThirdParty/ZLIB/src/itkzlib-ng/crc32_braid_tbl.h hooks-max-size=700000
Modules/Filtering/Denoising/include/itkPatchBasedDenoisingImageFilter.hxx hooks-max-size=120000
Documentation/ReleaseNotes/* hooks-max-size=300000
Documentation/docs/releases/* hooks-max-size=300000
Utilities/Doxygen/doxygen.config.in hooks-max-size=150000
Wrapping/Generators/Doc/doxygen.config.in hooks-max-size=150000

Expand Down
2 changes: 1 addition & 1 deletion Documentation/Maintenance/Release.md
Original file line number Diff line number Diff line change
Expand Up @@ -836,7 +836,7 @@ Release Notes Posts
-------------------

To get started with the release notes, first use the download link
cookiecutter to generate Markdown and webpage Download page HTML:
cookiecutter to generate [Download page](https://github.com/InsightSoftwareConsortium/ITK/blob/master/Documentation/docs/download.md) markdown:

```sh
pip install cookiecutter
Expand Down
2 changes: 1 addition & 1 deletion Documentation/docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
# html_logo = "_static/itk-logo.svg"
html_logo = "_static/itk-logo-low-res.png"
html_favicon = "_static/icon/favicon.ico"
html_title = f"{project} documentation"
html_title = f"{project}'s documentation"

# Furo options
html_theme_options = {
Expand Down
2 changes: 1 addition & 1 deletion Documentation/docs/contributing/code_of_conduct.md
Original file line number Diff line number Diff line change
Expand Up @@ -357,7 +357,7 @@ Harassment will not be tolerated in any of its forms either. Specifically:

Although the above list cannot be exhaustive, we will not tolerate
discrimination based on any of the protected characteristics in our
[Diversity Statement](motivation.md#diversity-statement).
[Diversity Statement](motivation.md).

The relative anonymity (if any) in the discussion forums is no shelter for
unacceptable behavior.
Expand Down
143 changes: 102 additions & 41 deletions Documentation/docs/download.md
Original file line number Diff line number Diff line change
@@ -1,55 +1,115 @@
Download ITK
============

This page documents how to download ITK. See our
[CONTRIBUTING](contributing/index) guide for more information.
💾 Current release
------------------

Download ITK Release Assets
---------------------------
More information on this release can be found in the [release notes](releases/5.3.md).

ITK release tarballs, including:
### Python packages

- Source code
- Regression test data
- Doxygen documentation
- ITK's Software Guide
- ITK's Examples
To install the [ITK Python packages],

can be downloaded from [ITK's GitHub Releases
page](https://github.com/InsightSoftwareConsortium/ITK/releases).
```sh
pip install itk
```

Additionally, wheels for external modules are available through the Python Package Index ([PyPI]).

### Release artifacts

**Guide and Textbook**

- [InsightSoftwareGuide-Book1-5.3.0.pdf](https://github.com/InsightSoftwareConsortium/ITK/releases/download/v5.3.0/InsightSoftwareGuide-Book1-5.3.0.pdf)
- [InsightSoftwareGuide-Book2-5.3.0.pdf](https://github.com/InsightSoftwareConsortium/ITK/releases/download/v5.3.0/InsightSoftwareGuide-Book2-5.3.0.pdf)

**Library Sources**

- [InsightToolkit-5.3.0.tar.gz](https://github.com/InsightSoftwareConsortium/ITK/releases/download/v5.3.0/InsightToolkit-5.3.0.tar.gz)
- [InsightToolkit-5.3.0.zip](https://github.com/InsightSoftwareConsortium/ITK/releases/download/v5.3.0/InsightToolkit-5.3.0.zip)

**Testing Data**

Unpack optional testing data in the same directory where the Library Source is unpacked.

- [InsightData-5.3.0.tar.gz](https://github.com/InsightSoftwareConsortium/ITK/releases/download/v5.3.0/InsightData-5.3.0.tar.gz)
- [InsightData-5.3.0.zip](https://github.com/InsightSoftwareConsortium/ITK/releases/download/v5.3.0/InsightData-5.3.0.zip)

**Checksums**

- [MD5SUMS](https://github.com/InsightSoftwareConsortium/ITK/releases/download/v5.3.0/MD5SUMS)
- [SHA512SUMS](https://github.com/InsightSoftwareConsortium/ITK/releases/download/v5.3.0/SHA512SUMS)


Additional releases can be downloaded from [ITK's GitHub Releases page].

✨ Latest pre-release
---------------------

More information on this release can be found in the [release notes](releases/5.4rc01.md).

### Python packages

To install the [ITK Python packages],

```sh
pip install --upgrade pip
pip install --pre --upgrade itk
```

### Linux Package Distributions
### Release artifacts

**Guide and Textbook**

- [InsightSoftwareGuide-Book1-5.4rc01.pdf](https://github.com/InsightSoftwareConsortium/ITK/releases/download/v5.4rc01/InsightSoftwareGuide-Book1-5.4rc01.pdf)
- [InsightSoftwareGuide-Book2-5.4rc01.pdf](https://github.com/InsightSoftwareConsortium/ITK/releases/download/v5.4rc01/InsightSoftwareGuide-Book2-5.4rc01.pdf)

**Library Sources**

- [InsightToolkit-5.4rc01.tar.gz](https://github.com/InsightSoftwareConsortium/ITK/releases/download/v5.4rc01/InsightToolkit-5.4rc01.tar.gz)
- [InsightToolkit-5.4rc01.zip](https://github.com/InsightSoftwareConsortium/ITK/releases/download/v5.4rc01/InsightToolkit-5.4rc01.zip)

**Testing Data**

Unpack optional testing data in the same directory where the Library Source is unpacked.

- [InsightData-5.4rc01.tar.gz](https://github.com/InsightSoftwareConsortium/ITK/releases/download/v5.4rc01/InsightData-5.4rc01.tar.gz)
- [InsightData-5.4rc01.zip](https://github.com/InsightSoftwareConsortium/ITK/releases/download/v5.4rc01/InsightData-5.4rc01.zip)

**Checksums**

- [MD5SUMS](https://github.com/InsightSoftwareConsortium/ITK/releases/download/v5.4rc01/MD5SUMS)
- [SHA512SUMS](https://github.com/InsightSoftwareConsortium/ITK/releases/download/v5.4rc01/SHA512SUMS)

📦 Package managers
-------------------

ITK packages exist for many Linux distributions. For Debian and Ubuntu, they
can be obtained running

```sh
$ sudo apt-get install libinsighttoolkit5-dev
sudo apt-get install libinsighttoolkit5-dev
```

This will give you the libraries and development headers.

For information on other ITK packages and packages for other distributions, see
this [blog post].

### Python

ITK Python wheels are available through the Python Package Index ([PyPI]).

To install the ITK Python wheel, use
ITK is available in [vcpkg] as `itk`:

```sh
$ python -m pip install --upgrade pip
$ python -m pip install itk
vcpkg install itk
```

Additionally, wheels for external modules may also be available through the
Python Package Index ([PyPI]).
If you're a [Homebrew](https://brew.sh/) user, you can install [itk](https://formulae.brew.sh/formula/itk) via:

Check the [ITKPythonPackage] website for further information.
```sh
brew install itk
```

Download ITK Sources with Git
-----------------------------
🚀 Latest sources with Git
--------------------------

First, [download and install Git](https://git-scm.com/downloads).

Expand All @@ -63,21 +123,21 @@ for further information on configuring and building ITK.
Clone ITK using the commands

```sh
$ git clone https://github.com/InsightSoftwareConsortium/ITK
$ cd ITK
git clone https://github.com/InsightSoftwareConsortium/ITK
cd ITK
```

The latest stable release can be cloned into a local repository using

```sh
$ git clone -b release https://github.com/InsightSoftwareConsortium/ITK ITKLatestRelease
git clone -b release https://github.com/InsightSoftwareConsortium/ITK ITKLatestRelease
```
where `ITKLatestRelease` is the name of the local repository created.

Additionally, specific releases can be cloned using the tags, for example:

```sh
$ git clone -b v5.3.0 https://github.com/InsightSoftwareConsortium/ITK ITK-5.3.0
git clone -b v5.3.0 https://github.com/InsightSoftwareConsortium/ITK ITK-5.3.0
```
where `v5.3.0` corresponds to ITK 5.3.0, and the `ITK-5.3.0` is the name
of the local repository created.
Expand All @@ -88,8 +148,8 @@ Users that have made no local changes and simply want to update a clone with
the latest changes may run

```sh
$ git checkout master
$ git pull --rebase upstream master
git checkout master
git pull --rebase upstream master
```

Avoid making local changes unless you have read our [developer
Expand All @@ -105,7 +165,7 @@ should guarantee only bug fixes to the functionality available in the latest
release:

```sh
$ git checkout --track -b release origin/release
git checkout --track -b release origin/release
```

This local branch will always follow the latest `release`. Use the [#update]
Expand All @@ -114,23 +174,24 @@ instructions to update it.
Alternatively, one may checkout a specific release tag using

```sh
$ git checkout v5.3.0
git checkout v5.3.0
```

Release tags never move. Repeat the command with a different tag to get a
different release. One may list available tags using:

```sh
$ git tag
git tag
```


[blog post]: https://blog.kitware.com/itk-packages-in-linux-distributions/
[CMake]: https://cmake.org/
[download page]: https://itk.org/ITK/resources/software.html
[Git]: https://git-scm.com
[ITK Python packages]: https://itkpythonpackage.readthedocs.io/en/latest/Quick_start_guide.html
[ITK's GitHub Releases
page]: https://github.com/InsightSoftwareConsortium/ITK/releases
[ITKPythonPackage]: https://itkpythonpackage.readthedocs.io/en/latest/index.html
[ITK Software Guide]: https://itk.org/ItkSoftwareGuide.pdf

[CMake]: https://cmake.org/

[Git]: https://git-scm.com
[PyPI]: https://pypi.python.org/pypi
[PyPI]: https://pypi.org/search/?q=itk
[vcpkg]: https://github.com/microsoft/vcpkg
4 changes: 2 additions & 2 deletions Documentation/docs/releases/5.3.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ ITK 5.3.0 Release Notes: 3D Slicer Python Packages

We are exceedingly pleased to announce the [Insight Toolkit (ITK)](https://itk.org) 5.3.0 is available for download! :tada: :santa: :gift: ITK is an open-source, cross-platform toolkit for N-dimensional scientific image processing, segmentation, and registration in a spatially-oriented architecture.

:flashlight: Highlights
-------------------------
🔦 Highlights
-------------

ITK 5.3 is a feature release that

Expand Down
6 changes: 3 additions & 3 deletions Documentation/docs/releases/5.4rc01.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

We are happy to announce the [Insight Toolkit (ITK)](https://itk.org) 5.4 Release Candidate 1 is available for testing! :tada: ITK is an open-source, cross-platform toolkit for N-dimensional scientific image processing, segmentation, and registration.

:flashlight: Highlights
-------------------------
🔦 Highlights
-------------

ITK 5.4 is a feature release that continues our modern C++ evolution by requiring C\+\+17. The toolkit progresses in performance with a simple and elegant style and syntax. Through hundreds of changes in this release, we advance in readability and maintainability for the library and client code, often facilitated by improvements in the C++ standards.

Expand Down Expand Up @@ -1870,4 +1870,4 @@ Remote Module Changes Since v5.3.0
- fix(createWebWorkerPromise): Move up one directory ([1ed0b88f](https://github.com/InsightSoftwareConsortium/itk-wasm/commit/1ed0b88f))
- build(toolchains): Bump to wasi-sdk-19, emscripten latest release ([fcc852e2](https://github.com/InsightSoftwareConsortium/itk-wasm/commit/fcc852e2))
- feat(itk-wasm-cli): Update default Docker image for 20230116-fcc852e2 ([358f42bc](https://github.com/InsightSoftwareConsortium/itk-wasm/commit/358f42bc))
- [...]
- [...]
12 changes: 2 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,10 @@ Links
-----

* [Homepage](https://itk.org)
* [Download](https://itk.org/download/)
* [Documentation](https://docs.itk.org/en/latest/)
* [Download](https://docs.itk.org/en/latest/download.html)
* [Documentation](https://docs.itk.org/)
* [Discussion](https://discourse.itk.org/)
* [Software Guide](https://itk.org/ItkSoftwareGuide.pdf)
* [Help](https://itk.org/resources/)
* [Examples](https://examples.itk.org/)
* [Issue tracking](https://github.com/InsightSoftwareConsortium/ITK/issues)
* [Submit a patch](CONTRIBUTING.md)
Expand Down Expand Up @@ -76,16 +75,9 @@ or
conda install -c conda-forge itk
```

If you're a [Homebrew](https://brew.sh/) user, you can install [itk](https://formulae.brew.sh/formula/itk) via:

```sh
brew install itk
```

The cross-platform, C++ core of the toolkit may be built from source using
[CMake](https://cmake.org).


Copyright
---------

Expand Down

This file was deleted.

Loading

0 comments on commit 497bfda

Please sign in to comment.