Skip to content

Commit

Permalink
Merge pull request #208 from EmmaRenauld/documentation
Browse files Browse the repository at this point in the history
Update the documentation
  • Loading branch information
EmmaRenauld committed Oct 27, 2023
2 parents b07544b + 120fa09 commit 35053eb
Show file tree
Hide file tree
Showing 37 changed files with 555 additions and 445 deletions.
28 changes: 19 additions & 9 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,10 +1,20 @@
flake8:
@if command -v flake8 > /dev/null; then \
echo "Running flake8"; \
flake8 flake8 --ignore N802,N806 `find . -name \*.py | grep -v setup.py | grep -v /doc/`; \
else \
echo "flake8 not found, please install it!"; \
exit 1; \
fi;
@echo "flake8 passed"
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = source
BUILDDIR = build

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14 changes: 1 addition & 13 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ Links
=====

* `Getting started: installation and download <https://dwi-ml.readthedocs.io/en/latest/getting_started.html>`_
* `Complete documentation with a step-by-step process explanation <https://dwi-ml.readthedocs.io/en/latest/>`_
* `Contribute/Submit a patch <https://github.com/scil-vital/dwi_ml/blob/master/CONTRIBUTING.rst>`_
* `Issue tracking <https://github.com/scil-vital/dwi_ml/issues>`_

Expand All @@ -29,19 +30,6 @@ DWI_ML is a toolkit for Diffusion Magnetic Resonance Imaging (dMRI) analysis
using machine learning and deep learning methods. It is mostly focused on the
tractography derivatives of dMRI.

**Here is the usual workflow for people using dwi_ml**:

1. `Organize your data <https://dwi-ml.readthedocs.io/en/latest/data_organization.html>`_. If your data is organized as expected, the following steps will be much easier.

2. `Preprocess your data <https://dwi-ml.readthedocs.io/en/latest/preprocessing.html>`_.
- Preprocess your diffusion data using Tractoflow
- Preprocess your tractogram using RecoBundlesX

3. `Create your own project with DWI_ML <https://dwi-ml.readthedocs.io/en/latest/processing.html>`_.
- Create your own repository for your project.
- Copy our scripts from ``please_copy_and_adapt``. Adapt based on your needs.
- Train your ML algorithm
- If needed, create your tracking algorithm based on your results.

License
=======
Expand Down
9 changes: 0 additions & 9 deletions doc/_static/my_style.css

This file was deleted.

9 changes: 0 additions & 9 deletions doc/adapting_dwiml.rst

This file was deleted.

65 changes: 0 additions & 65 deletions doc/conf.py

This file was deleted.

64 changes: 0 additions & 64 deletions doc/config_file.rst

This file was deleted.

61 changes: 0 additions & 61 deletions doc/creating_hdf5.rst

This file was deleted.

50 changes: 0 additions & 50 deletions doc/data_organization.rst

This file was deleted.

44 changes: 0 additions & 44 deletions doc/index.rst

This file was deleted.

1 change: 0 additions & 1 deletion doc/readme_link.rst

This file was deleted.

1 change: 0 additions & 1 deletion doc/requirements_doc.txt

This file was deleted.

Loading

0 comments on commit 35053eb

Please sign in to comment.