diff --git a/.readthedocs.yaml b/.readthedocs.yaml deleted file mode 100644 index f854d89..0000000 --- a/.readthedocs.yaml +++ /dev/null @@ -1,23 +0,0 @@ -# Required -version: 2 - -# Set the OS, Python version and other tools you might need -build: - os: ubuntu-22.04 - tools: - python: "3.11" - -# Build documentation in the "docs/" directory with Sphinx -sphinx: - configuration: docs/source/conf.py - -# Optionally build your docs in additional formats such as PDF and ePub -formats: - - pdf - -# Optional but recommended, declare the Python requirements required -# to build your documentation -# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html -python: - install: - - requirements: docs/requirements.txt diff --git a/docs/requirements.txt b/docs/requirements.txt deleted file mode 100644 index 11b672b..0000000 --- a/docs/requirements.txt +++ /dev/null @@ -1,8 +0,0 @@ -sphinx-rtd-theme==1.3.0 -sphinx>=7.0.1 -nbsphinx>=0.9.2 -ipython>=8.12.0 -matplotlib>=3.7.1 -numpy>=1.23.5 -pytest>=7.4.4 -scipy>=1.11.4 diff --git a/docs/source/_static/logo.png b/docs/source/_static/logo.png deleted file mode 100644 index d35e270..0000000 Binary files a/docs/source/_static/logo.png and /dev/null differ diff --git a/docs/source/conf.py b/docs/source/conf.py deleted file mode 100644 index b2c724f..0000000 --- a/docs/source/conf.py +++ /dev/null @@ -1,43 +0,0 @@ -# Configuration file for the Sphinx documentation builder. -# -# For the full list of built-in configuration values, see the documentation: -# https://www.sphinx-doc.org/en/master/usage/configuration.html - -# -- Project information ----------------------------------------------------- -# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information - -project = 'SpinWalk' -copyright = '2024, Ali Aghaeifar' -author = 'Ali Aghaeifar' -release = '1.0.0' - -# -- General configuration --------------------------------------------------- -# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration - -extensions = [] - -templates_path = ['_templates'] -exclude_patterns = [] - - - -# -- Options for HTML output ------------------------------------------------- -# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output - -html_theme = 'sphinx_rtd_theme' -html_static_path = ['_static'] - - -html_logo = "_static/logo.png" - - -# Specify master doc so build at read the docs won't fail -master_doc = "index" - -# Syntax highlighting -pygments_style = "stata-light" -pygments_dark_style = "stata-dark" - -autodoc_default_options = { - "imported-members": True, -} \ No newline at end of file diff --git a/docs/source/create_phantom.rst b/docs/source/create_phantom.rst deleted file mode 100644 index 25b3e7b..0000000 --- a/docs/source/create_phantom.rst +++ /dev/null @@ -1,3 +0,0 @@ -############## -Create Phantom -############## \ No newline at end of file diff --git a/docs/source/index.rst b/docs/source/index.rst deleted file mode 100644 index de71ee1..0000000 --- a/docs/source/index.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. SpinWalk documentation master file, created by - sphinx-quickstart on Thu Jul 11 16:25:54 2024. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Welcome to SpinWalk's documentation! -==================================== - -.. toctree:: - :maxdepth: 2 - :caption: Contents: - - installation - tutorial - io_file - create_phantom - View on GitHub \ No newline at end of file diff --git a/docs/source/installation.rst b/docs/source/installation.rst deleted file mode 100644 index 1366050..0000000 --- a/docs/source/installation.rst +++ /dev/null @@ -1,50 +0,0 @@ -############### -Installation -############### - - -*************** -How to build -*************** - -You can either use the supplied Dockerfile for a consistent build that includes all dependencies, or install the dependencies separately and compile using CMake. - -Docker -=============== - -We suggest utilizing the provided Dockerfile, which automates the installation of all dependencies, as well as the cloning and building of the program. Download the Dockerfile to your current directory and then execute the following commands: - - -In almost any documentation you need to show examples like: - - -.. code-block:: bash - - docker build --no-cache -t spinwalk . - docker run --gpus all --rm -it --runtime=nvidia spinwalk bash - -CMake -=============== - -Dependencies ---------------- -* A C++ compiler supprting C++ 20 -* CUDA driver (nvidia-smi and nvcc --version must run in terminal) -* Boost libraries (+) -* HDF5 Library (+) -* Threading Building Blocks (TBB). - -If you prefer to install the program without using Docker, follow these steps (tested in Ubuntu 22.04): - -.. code-block:: bash - - sudo apt-get update && apt-get install -y libboost-all-dev libhdf5-dev libtbb-dev - git clone https://github.com/aghaeifar/SpinWalk.git - cd SpinWalk - cmake -B ./build - cmake --build ./build --config Release - -********************** -Quick test after build -********************** -After building the program, simply launch ``spinwalk`` in the terminal to view the help menu with all available options. At the end of the output, the detected GPUs and driver must be displayed. diff --git a/docs/source/io_file.rst b/docs/source/io_file.rst deleted file mode 100644 index 6e23f8f..0000000 --- a/docs/source/io_file.rst +++ /dev/null @@ -1,3 +0,0 @@ -############### -Data Structures -############### \ No newline at end of file diff --git a/docs/source/tutorial.rst b/docs/source/tutorial.rst deleted file mode 100644 index 5037ff6..0000000 --- a/docs/source/tutorial.rst +++ /dev/null @@ -1,3 +0,0 @@ -######## -Tutorial -######## \ No newline at end of file