CERN / TIGRE

TIGRE: Tomographic Iterative GPU-based Reconstruction Toolbox
BSD 3-Clause "New" or "Revised" License
580 stars 189 forks source link

README.md in 2 different directories #108

Closed miphilomath closed 5 years ago

miphilomath commented 5 years ago

Expected Behavior

Single README.md file should be present in the top level directory of the project tree.

Actual Behavior

Another README.md file is present under Python Directory, leading to inconsistency in its content.

Inconsistency is shown using diff Python/README.md README.md -y command.

TIGRE: Tomographic Iterative GPU-based Reconstruction Toolbox   TIGRE: Tomographic Iterative GPU-based Reconstruction Toolbox
======                              ======

TIGRE is a PYTHON/CUDA toolbox for fast and accurate 3D       | TIGRE is a MATLAB and Python/CUDA toolbox for fast and accura
reconstruction, created jointly by University of Bath's       | reconstruction (any geometry), created jointly by University 
                                  > 
The aim of TIGRE is to provide a wide range of easy-to-use it   The aim of TIGRE is to provide a wide range of easy-to-use it
We would like to build an stronger bridge between algorithm r   We would like to build an stronger bridge between algorithm r
imaging researchers, by encouraging and supporting contributi   imaging researchers, by encouraging and supporting contributi
TIGRE. TIGRE is free to use and distribute, use it, modi      | TIGRE. 
                                  > 
                                  > TIGRE is free to use and distribute, use it, modify it, break
the only requirement is proper referencing to the authors.      the only requirement is proper referencing to the authors.

Currently it contains Cone Beam CT geometries, and a bet      <

If you wissh to be added to the mailing list of TIGRE, please   If you wissh to be added to the mailing list of TIGRE, please
We will only contact you whenever a new version of TIGRE is r   We will only contact you whenever a new version of TIGRE is r

TIGRE is still being developed and we are still adding new fe   TIGRE is still being developed and we are still adding new fe

**TIGRE in media**:                           <

[Article of Medical Physics Web on TIGRE](http://medical      | [Read the PhD Thesis of Ander Biguri](https://github.com/Ande

Donwload: [https://github.com/CERN/TIGRE/releases][7]       Donwload: [https://github.com/CERN/TIGRE/releases][7]

**NEWS**                              | ## **NEWS**

TIGRE-python version 0.1.0 released for use. Changes hav      | There is a somehow working version of Python that still needs
As well as this, style follows the formal python format       | If you are interested in controbuting, please contact us. 
SemiUpperCase. Functions, such as the algorithms, are lo      <
IterativeReconAlg. Demos have been updated for this form      <
instructions will follow as progress continues towards m      <

**TIGRE features**:                           | ## **TIGRE features**:

  - Fast, state of the art projection using interpolatio      |   - Fast, state of the art projection using two modes of ray 

  - Fast, state of the art backprojection, with FDK weig      |   - Fast, state of the art backprojection using two modes (FD
                                  >   
                                  >   - Wide geometric flexibility, being possible to change most

  - A wide range of algorithms with multiple configurations f     - A wide range of algorithms with multiple configurations f
      - FDK                                   - FDK
      - Gradien descend family                        - Gradien descend family
        - SART                                              - SART                    
        - OS-SART                                           - OS-SART                
        - SIRT                                  - SIRT
                                  >       - Krylov Subspace
                                  >         - CGLS
                                  >       - Statistical methods
                                  >         - MLEM
                                  >       - Total Variation
                                  >         - ADS-POCS               
                                  >         - OSC-POCS              
                                  >         - B-ADS-POCS-&#946;       
                                  >         - SART-TV
                                  >         - PCSD
                                  >         - AwASD-POCS
                                  >         - AwPCSD
                                  >       

  - A variety of plotting functions                   |   - TV denoising for 3D images
                                  > 
                                  >   - A variety of basic plotting functions

  - Quality measures                          - Quality measures

## How to install TIGRE-python                    <

(Tested on Linux 64 machines, please [report any              | ## How to install TIGRE
issue][2] if it doesnt work in other arch/OS)             <

                                  > (Tested on win 64 and Linux 64 machines, please [report any 
                                  > issue][2] if it doesnt work in other arch/OS)
                                  >  
                                  >    - Download TIGRE from the downloads page
                                  >    
   - Install  CUDA Toolkit (the later, the better)             - Install  CUDA Toolkit (the later, the better)
     Download [here][1]                          Download [here][1]
   - Clone the repo by:                           |      
      > git clone https://github.com/CERN/TIGRE.git           |    - Install a compatible compiler (the Best option Visual St
   - Change directory                         |    
      > cd TIGRE/Python/                          |    - Run Compile.m
   - and run the setup file:                      <
      > python setup.py install                   <
   - python may need permission to install to certain di      <
   in which case do:                          <
      > sudo --preserve-env python setup.py install           <

If it doesn't work                          If it doesn't work
                                  >    
                                  >    - Make sure a compiler is set up in your MATLAB. run `mex 
                                  >      compiler is not set up, make sure you download one (some
                                  >      and run mex -setup again.
                                  >    
                                  >    - Make sure the xml file for compiling is properly set up.
                                  >      mex_CUDA_glnxa64.xml should be present, and inside it th
                                  > 
                                  >    - On linux machines, make sure you modify `mex_CUDA_glnxa6
                                  >    
                                  >    - Try `getenv('CUDA_PATH')`. If it doesn't return the path
                                  >    
                                  >    - Run Compile.m

   - Try setting up a py27 environment with:              |    - TIGRE should be ready to use!

       > conda create -n py27 python=2.7 anaconda             <

   - Now activate the environment from the CLI with           | ## Some fancy images

       > source activate py27                     | TIGRE gets this:
                                      | 
   - try the above steps again (making sure the py27 env      | ![Imgur](http://i.imgur.com/ahnFc05.gif?1)
                                  > 
                                  > And transforms it to this:
                                  > 
                                  > ![this image](http://i.imgur.com/NcVEac2.gif?1)

   - TIGRE should be ready to use!                    | And much more! There are 11 algorithms that will behave diffe
                                  > Just get it, and try your data! 
                                  > 
                                  > 
                                  > 
                                  > ## Getting started & Documentation
                                  > 
                                  > 
                                  > The first thing you need to do is run `InitTIGRE`, to initial
                                  > folders and subfolders if the toolbox.
                                  > 
                                  > Currently the documentation is included in each of the functi
                                  > by typing `help function_name` or by selecting the function i
                                  > Additionally, the demos should include all the necessary docu

**Getting started with TIGRE-python**                 <

  - After installing the software following the instruct      <

## Issues                               ## Issues

If you have any issues with compiling/running TIGRE, or you f   If you have any issues with compiling/running TIGRE, or you f
the code, please report it on [the issues page][2]<sup>&#8727   the code, please report it on [the issues page][2]<sup>&#8727

Please, be as clear as  possible with the description of the    Please, be as clear as  possible with the description of the 
If it is a specific problem in an specific scenario, provide    If it is a specific problem in an specific scenario, provide 
Complete Verifiable Example* of the problem (see [Stackoverfl   Complete Verifiable Example* of the problem (see [Stackoverfl

<sup>&#8727;</sup> **Protip** you can [label the Issues by to   <sup>&#8727;</sup> **Protip** you can [label the Issues by to

## I want to contribute!                        ## I want to contribute! 

Wow! We are glad you do! Please, if you want to contribute ne   Wow! We are glad you do! Please, if you want to contribute ne
algorithms, pre- or post- processing techniques, bug-fixes, d   algorithms, pre- or post- processing techniques, bug-fixes, d
*anything* you thing it can help the community, please, do! W   *anything* you thing it can help the community, please, do! W
this behaviour!                         this behaviour!

*But how?*                              *But how?* 

Easy! you can download the git repo, and make a pull request    Easy! you can download the git repo, and make a pull request 
contribution. We will review it and add it if its suited for    contribution. We will review it and add it if its suited for 

If you don't know how git                       If you don't know how git
works<sup>1</sup> you can also send an email us to tigre.tool   works<sup>1</sup> you can also send an email us to tigre.tool
with your contribution, and an explanation of what it does an   with your contribution, and an explanation of what it does an
review and add the contribution if suited.              review and add the contribution if suited.

If your contribution can be linked to a published, peer-revie   If your contribution can be linked to a published, peer-revie
an arXiv entry, please let us know so we can make sure the `c   an arXiv entry, please let us know so we can make sure the `c
includes your contributions.                    includes your contributions.

## FAQ                              ## FAQ

                                  > **Q: I get "the launch timed out and was terminated" error wh
                                  > in my computer**
                                  > 
                                  > *A: This happens because your GPU takes too long (according t
                                  > running the code. Don't worry, too long means about 100ms or 
                                  > to make sure to change the OS's GPU watchdog time. 
                                  > If you are working on a TESLA, setting the TESLA to TCC mode 
                                  > 
                                  > **Q: After running something I got an error in Ax or Atb and 
                                  > 
                                  > *A: Unfortunately when CUDA has an error, it hungs. You need 
                                  > this. Hopefully we can find a solution for this without the n
                                  > 
                                  > **Q: Does it work in MATLAB XXXX with Compiler XXXX in OS XXX
                                  > 
                                  > *A: In general, it should, as long as you are following both 
                                  > The truth is that there is few compilers that fit the eeligib
                                  > should not be a problem.*
                                  > 
**Q: I get a fair amount of warnings when I compile the code,   **Q: I get a fair amount of warnings when I compile the code,

*A: Do not worry about the warnings. We are perfectly aware o   *A: Do not worry about the warnings. We are perfectly aware o
effect whatsoever in the correct execution (both in computati   effect whatsoever in the correct execution (both in computati

## Licensing                            ## Licensing

TIGRE toolbox is released under the BSD License, meaning you    TIGRE toolbox is released under the BSD License, meaning you 
the software freely in any case, but you **must** give attrib   the software freely in any case, but you **must** give attrib
For more information, read the license file or the [BSD Licen   For more information, read the license file or the [BSD Licen

## Contact                              ## Contact

*Before contacting* consider that you might be able to let us   *Before contacting* consider that you might be able to let us
[raising an issue][2] and [labeling accordingly][4].        [raising an issue][2] and [labeling accordingly][4]. 

If you want to contact us for other reasons than an issue wit   If you want to contact us for other reasons than an issue wit

tigre.toolbox@gmail.com                     tigre.toolbox@gmail.com

or contact the author directly in                   or contact the author directly in

MATLAB:                               | ander.biguri@gmail.com
a.biguri@bath.ac.uk                           <
                                  <
Python:                               <
reuben.jonathan.lindroos@cern.ch                      <

We will make an effort to answer as soon as we can.         We will make an effort to answer as soon as we can.

## Referencing TIGRE                        ## Referencing TIGRE

If you use TIGRE in any publications, please reference the fo   If you use TIGRE in any publications, please reference the fo

**TIGRE: A MATLAB-GPU toolbox for CBCT image reconstruction**   **TIGRE: A MATLAB-GPU toolbox for CBCT image reconstruction**
*Ander Biguri, Manjit Dosanjh, Steven Hancock, and Manuchehr    *Ander Biguri, Manjit Dosanjh, Steven Hancock, and Manuchehr 
**Biomedical Physics & Engineering Express, Volume 2, Number    **Biomedical Physics & Engineering Express, Volume 2, Number 
[Read the article (Open Access)][8]                 [Read the article (Open Access)][8]

Also, if you use any algorithm, you should reference the corr   Also, if you use any algorithm, you should reference the corr
of the algorithms. If you don't know the article, use `citeme   of the algorithms. If you don't know the article, use `citeme
and the right reference will appear.                and the right reference will appear.

---                                 ---

<sup>1</sup> You can learn, it is very useful!          <sup>1</sup> You can learn, it is very useful!

[1]: https://developer.nvidia.com/cuda-downloads        [1]: https://developer.nvidia.com/cuda-downloads
[2]: https://github.com/CERN/TIGRE/issues               [2]: https://github.com/CERN/TIGRE/issues
[3]: https://stackoverflow.com/help/mcve            [3]: https://stackoverflow.com/help/mcve
[4]: https://help.github.com/articles/applying-labels-to-issu   [4]: https://help.github.com/articles/applying-labels-to-issu
[5]: http://www.linfo.org/bsdlicense.html               [5]: http://www.linfo.org/bsdlicense.html
[6]: https://github.com/CERN/TIGRE/license.txt            | [6]: https://github.com/CERN/TIGRE/blob/master/LICENSE
[7]: https://github.com/CERN/TIGRE/releases             [7]: https://github.com/CERN/TIGRE/releases
[8]: http://iopscience.iop.org/article/10.1088/2057-1976/2/5/   [8]: http://iopscience.iop.org/article/10.1088/2057-1976/2/5/

Suggestion

We should dissolve the README.md in the Python directory as README of the project should be in the root directory.

miphilomath commented 5 years ago

Another README.txt is present under ./MATLAB/Colormaps/.

AnderBiguri commented 5 years ago

Indeed, thanks for reporting this!

We are currently working on a new readme, that you can find in the branch named frontispiece. I will make sure this issue is tackled before merging. Ander

On Mon, 4 Mar 2019, 07:02 Mohit Bansal (Philomath), < notifications@github.com> wrote:

Another README.txt is present under ./MATLAB/Colormaps/.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/CERN/TIGRE/issues/108#issuecomment-469140803, or mute the thread https://github.com/notifications/unsubscribe-auth/ALTiNP30nzf-VX0ADAsgNmZjpvrjzgwJks5vTMTvgaJpZM4bbrFv .