Skip to content

Commit

Permalink
DOC: Update Download page for release artifacts
Browse files Browse the repository at this point in the history
Add "Current release" and "Latest pre-release" sections. Add emoji's and
shorten titles for conciseness, clarity, and style. Add vcpkg to
"Package managers" section -- more package managers and the contents of
the referenced blog post could be added in the future.

Update download page cookiecutter markdown for future release notes and
download page content. We now direct to the sphinx download page so
remove the Wordpress HTML output.
  • Loading branch information
thewtex committed Nov 6, 2023
1 parent 7f3f616 commit b4826a4
Show file tree
Hide file tree
Showing 4 changed files with 95 additions and 130 deletions.
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
137 changes: 94 additions & 43 deletions Documentation/docs/download.md
Original file line number Diff line number Diff line change
@@ -1,55 +1,105 @@
Download ITK
============

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

Download ITK Release Assets
---------------------------
### Python packages

ITK release tarballs, including:
To install the [ITK Python packages],

- Source code
- Regression test data
- Doxygen documentation
- ITK's Software Guide
- ITK's Examples
```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
---------------------

### Python packages

To install the [ITK Python packages],

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

can be downloaded from [ITK's GitHub Releases
page](https://github.com/InsightSoftwareConsortium/ITK/releases).
### Release artifacts

### Linux Package Distributions
**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]).

Check the [ITKPythonPackage] website for further information.

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

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

Expand All @@ -63,21 +113,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 +138,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 +155,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 +164,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

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,6 @@ Install [ITK Python packages](https://itkpythonpackage.readthedocs.io/en/latest/
pip install --upgrade itk
```

or:

```sh
conda install -c conda-forge itk
```

**Guide and Textbook**

- [InsightSoftwareGuide-Book1-{{ cookiecutter.major_version }}.{{ cookiecutter.minor_version }}{{ cookiecutter.patch_identifier }}{{ cookiecutter.patch_version }}.pdf](https://github.com/InsightSoftwareConsortium/ITK/releases/download/v{{ cookiecutter.major_version }}.{{cookiecutter.minor_version }}{{ cookiecutter.patch_identifier }}{{ cookiecutter.patch_version }}/InsightSoftwareGuide-Book1-{{ cookiecutter.major_version }}.{{cookiecutter.minor_version }}{{ cookiecutter.patch_identifier }}{{ cookiecutter.patch_version }}.pdf)
Expand Down

0 comments on commit b4826a4

Please sign in to comment.