Skip to content

Commit

Permalink
DOC : Update new ReadTheDocs with content from the old documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
axel-grc committed Dec 20, 2024
1 parent bc7f3d6 commit 4009b86
Show file tree
Hide file tree
Showing 50 changed files with 1,091 additions and 293 deletions.
25 changes: 25 additions & 0 deletions CodeContribution.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Code contribution

## Coding style

RTK is based on ITK and aims at following its coding conventions. Any developer should follow these conventions when submitting new code or contributions to the existing one. We strongly recommend you to read thoroughly [ITK's style guide](http://www.itk.org/Wiki/ITK/Coding_Style_Guide).

## Testing

This section describes how to add/edit datasets for testing purposes for RTK. Datasets are not stored in the GIT repository for efficiency and also to avoid having large history due to binary files. Instead the files are stored on a [Girder](http://data.kitware.com) instance. Here's the recipe to add new datasets:

1. Register/Login to Girder hosted at Kitware: [http://data.kitware.com](http://data.kitware.com)
2. Locate the RTK collection: [https://data.kitware.com/#collection/5a7706878d777f0649e04776](https://data.kitware.com/#collection/5a7706878d777f0649e04776)
3. Upload the new datasets in the appropriate folder. If you don't have the necessary privileges please email the mailing list
4. In the GIT repository, add in testing/Data a file with the exact filename of the original file **but with the .md5 extension**. Inside that file put the md5sum of the file on Girder.
5. When adding a test use the new macro 'RTK_ADD_TEST' instead of 'ADD_TEST' and specify the datasets you want CTest to download by appending the data to 'DATA{}'. For example:

```
RTK_ADD_TEST(NAME rtkimagxtest
COMMAND ${EXECUTABLE\_OUTPUT\_PATH}/rtkimagxtest
DATA{Data/Input/ImagX/raw.xml,raw.raw}
DATA{Data/Baseline/ImagX/attenuation.mha})
```
## Dashboard

* The RTK dashboard is available at [RTK Dashboard](http://my.cdash.org/index.php?project=RTK)
20 changes: 20 additions & 0 deletions INSTALLATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,26 @@ We also provide pre-compiled [CUDA](https://developer.nvidia.com/cuda-toolkit) p
python -m pip install itk-rtk-cuda116
```

Docker
---------------------

Another installation solution is to use the Docker solution provided by Thomas Baudier:

```
docker pull tbaudier/rtk:v1.3.0
docker run -ti --rm -e DISPLAY=$DISPLAY -v \[Documents\]:/home tbaudier/rtk:v1.3.0 bash
```
Information on what is installed can be reached using the commands:
```
docker images
docker ps -a
```
To clean it after use, you can do:
```
docker rm -f \[container id\]
docker rmi -f \[image id\]
```

Getting started
---------------
See [GettingStarted.md](GettingStarted.md). Your `CMakeLists.txt` can now use RTK when importing ITK as shown in the [FirstReconstruction's CMakeLists.txt](https://github.com/RTKConsortium/RTK/blob/master/examples/FirstReconstruction/CMakeLists.txt#L7).
289 changes: 0 additions & 289 deletions documentation/Doxygen/rtkThreeDCircularProjectionGeometry.dox

This file was deleted.

1 change: 1 addition & 0 deletions documentation/docs/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ if(RTK_BUILD_SPHINX)
COMMAND ${CMAKE_COMMAND} -E copy "${RTK_SOURCE_DIR}/index.md" "${RTK_DOC_OUTPUT_DIR}/index.md"
COMMAND ${CMAKE_COMMAND} -E copy "${RTK_SOURCE_DIR}/GettingStarted.md" "${RTK_DOC_OUTPUT_DIR}/GettingStarted.md"
COMMAND ${CMAKE_COMMAND} -E copy "${RTK_SOURCE_DIR}/INSTALLATION.md" "${RTK_DOC_OUTPUT_DIR}/INSTALLATION.md"
COMMAND ${CMAKE_COMMAND} -E copy "${RTK_SOURCE_DIR}/CodeContribution.md" "${RTK_DOC_OUTPUT_DIR}/CodeContribution.md"
COMMENT "Copying documentation sources"
)

Expand Down
Loading

0 comments on commit 4009b86

Please sign in to comment.