Skip to content

Commit 77bcb9c

Browse files
committed
DOC: Convert README and unmaintained-images from rst to markdown
Conversation done using pandoc and manually tweaked to fix indentation, headers and spacing as well as introducing GitHub alerts[^1] ``` $ pandoc -f rst -t gfm README.rst -o README.md $ pandoc -f rst -t gfm unmaintained-images.rst -o unmaintained-images.md ``` [^1]: https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts
1 parent af48c50 commit 77bcb9c

File tree

4 files changed

+97
-95
lines changed

4 files changed

+97
-95
lines changed

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Docker images for 3D Slicer
2+
3+
## Images
4+
5+
- slicer/slicer-notebook
6+
[![slicer-notebook-images](https://img.shields.io/docker/image-size/slicer/slicer-notebook/latest)](https://hub.docker.com/r/slicer/slicer-notebook)
7+
Ready-to-run Docker images containing Slicer and Jupyter. See [usage](#usage-of-slicer-notebook-image) information below.
8+
9+
- slicer/slicer-base
10+
[![slicer-base-images](https://img.shields.io/docker/image-size/slicer/slicer-base/latest)](https://hub.docker.com/r/slicer/slicer-base)
11+
The image used to build Slicer each time a Pull Request is submitted.
12+
For more details, see [GitHub Actions workflow](https://github.com/Slicer/Slicer/tree/main/.github)
13+
14+
### Unmaintained Images
15+
16+
Information about unmaintained images are available [here](unmaintained-images.md).
17+
18+
## Usage of `slicer-notebook` image
19+
20+
> [!WARNING]
21+
> `slicer/slicer-notebook` images on dockerhub are outdated, therefore the
22+
> examples below uses latest images from `lassoan/slicer-notebook`.
23+
24+
1. Start a Jupyter server by running this command:
25+
26+
Linux or macOS:
27+
28+
```
29+
docker run -p 8888:8888 -p 49053:49053 -v "$PWD":/home/sliceruser/work --rm -ti lassoan/slicer-notebook:latest
30+
```
31+
32+
Windows:
33+
34+
```
35+
docker run -p 8888:8888 -p 49053:49053 -v "%USERPROFILE%":/home/sliceruser/work --rm -ti lassoan/slicer-notebook:latest
36+
```
37+
38+
2. Open the link shown at the end of the command-line output (`http://127.0.0.1:8888/?token=...`) in a web browser.

README.rst

Lines changed: 0 additions & 36 deletions
This file was deleted.

unmaintained-images.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# Unmaintained Images
2+
3+
In the process of improving the Slicer infrastructure, these images are
4+
not updated anymore. Only the `slicer/slicer-base` image is used for
5+
continuous integration with [GitHub Actionsworkflow](https://github.com/Slicer/Slicer/tree/main/.github).
6+
7+
- slicer/slicer-dependencies
8+
[![slicer-dependencies-images](https://img.shields.io/docker/image-size/slicer/slicer-dependencies/latest)](https://hub.docker.com/r/slicer/slicer-dependencies)
9+
An image containing all the dependencies to build Slicer itself:
10+
ITK, VTK, CTK, Qt, etc.
11+
12+
- slicer/slicer-build
13+
[![slicer-build-images](https://img.shields.io/docker/image-size/slicer/slicer-build/latest)](https://hub.docker.com/r/slicer/slicer-build)
14+
An image containing a Slicer build tree along with all the
15+
dependencies to build Slicer.
16+
17+
- slicer/slicer-test
18+
[![slicer-test-images](https://img.shields.io/docker/image-size/slicer/slicer-test/latest)](https://hub.docker.com/r/slicer/slicer-test)
19+
An image containing a Slicer build and test tree along with all the
20+
dependencies to build Slicer.
21+
22+
- slicer/slicer-test:opengl
23+
[![slicer-test-opengl-images](https://img.shields.io/docker/image-size/slicer/slicer-test/opengl)](https://hub.docker.com/r/slicer/slicer-test)
24+
An image based on thewtex/opengl:centos which contains configuration
25+
files to run Slicer's tests
26+
27+
# Usage
28+
29+
To build and package a local Slicer source tree at `~/src/Slicer`
30+
against pre-built dependencies:
31+
32+
```
33+
docker run --name slicer slicer/slicer-dependencies
34+
# Copy the generated Slicer package to the /tmp/ directory.
35+
docker cp slicer:$(docker cp slicer:/usr/src/Slicer-build/Slicer-build/PACKAGE_FILE.txt - | tar xO) /tmp/
36+
docker rm slicer
37+
```
38+
39+
# Update
40+
41+
To update the Slicer revision, first download Slicer sources:
42+
43+
```
44+
git clone https://github.com/Slicer/Slicer
45+
```
46+
47+
Then download SlicerDocker sources and check out a local branch for the update:
48+
49+
```
50+
git clone [email protected]:Slicer/SlicerDocker
51+
cd SlicerDocker
52+
git checkout -b update-$(date +%F)
53+
```
54+
55+
And run the update script:
56+
57+
```
58+
./slicer-base/update.sh /path/to/src/Slicer
59+
```

unmaintained-images.rst

Lines changed: 0 additions & 59 deletions
This file was deleted.

0 commit comments

Comments
 (0)