Skip to content

Commit b6574cc

Browse files
teascavengerteascavenger
committed
Docs updated
1 parent 5f6c480 commit b6574cc

23 files changed

+182
-115
lines changed

‎CHANGELOG.md

+8-7
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,15 @@ All notable changes to this project will be documented in this file.
44
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
55
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
66

7-
## [Unreleased]
7+
## 0.1.0 - 2018-04-26
88
### Added
9-
- <insert-features-not-in-a-release-yet>
10-
### Fixed
11-
- <insert-bugs-fixed-not-in-a-release-yet>
9+
- Initial release
10+
- Added different calls to display functions
11+
- Added FISTA
12+
- Improved docs
13+
- Introduced new geometry classes
14+
- Added modules for polychromatic models
15+
- New examples
1216

13-
## 0.1.0 - YYYY-MM-DD
14-
### Added
15-
- Initial release.
1617

1718
[Unreleased]: https://www.github.com/teascavenger/flextomo/compare/v0.1.0...develop

‎README.md

+13-5
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# flexTOMO
22

3-
This project is a part of the larger X-ray tomographic reconstruction toolbox comprised of flexDATA, flexTOMO and flexCALC.
3+
This project is a part of the larger X-ray tomographic reconstruction toolbox comprised of [flexDATA], [flexTOMO] and [flexCALC].
44
flexTOMO provides a wrapper around a GPU-based tomographic reconstruction toolbox [ASTRA](https://www.astra-toolbox.com/).
55
The main purpose of this project is to provide an easy way to use cone-beam forward- and back-projectors. Another purpose is to collect various algebraic reconstruction algorithms, providing support for large disk-mapped arrrays (memmaps) and subsets that allow to both accelerate convergence and to save RAM.
66

@@ -12,17 +12,25 @@ Before installing flexTOMO, please download and install [flexDATA](https://githu
1212

1313
Simply install with:
1414
```
15-
TODO
15+
conda create -n <your-environment> python=3.6
16+
conda install -c cicwi -c astra-toolbox/label/dev -c conda-forge -c owlas flextomo
1617
```
1718

1819
### Installing from source
1920

20-
To install flexTOMO, clone this GitHub project. Go to the cloned directory and run PIP installer:
21+
To install flexTOMO you will need the latest version of the ASTRA toobox (preferably development version).
22+
We also recommend to install [Xraylib](https://anaconda.org/conda-forge/xraylib) module using Anaconda from the Conda-Forge channel:
23+
24+
```
25+
conda install -c astra-toolbox/label/dev astra-toolbox
26+
conda install -c conda-forge xraylib
27+
```
28+
29+
To install flexTOMO, simply clone this GitHub project. Go to the cloned directory and run PIP installer:
2130
```
2231
git clone https://github.com/cicwi/flextomo.git
23-
cd flextomo
32+
cd flexdata
2433
pip install -e .
25-
```
2634
2735
## Running the examples
2836

‎conda/meta.yaml

+2-1
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,14 @@ requirements:
1919

2020
run:
2121
- python
22+
2223
# dependencies are defined in setup.py
2324
{% for dep in data['install_requires'] %}
2425
- {{ dep.lower() }}
2526
{% endfor %}
2627

2728
about:
28-
home: https://github.com/teascavenger/flextomo
29+
home: https://github.com/cicwi/flexTOMO
2930
license_file: LICENSE.md
3031
summary: "ASTRA-based cone beam tomography reconstructions."
3132

‎docs/_modules/flextomo/model.html

+5
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,11 @@
8080

8181
<ul>
8282
<li class="toctree-l1"><a class="reference internal" href="../../readme.html">flexTOMO</a></li>
83+
<li class="toctree-l1"><a class="reference internal" href="../../readme.html#import">Import:</a></li>
84+
<li class="toctree-l1"><a class="reference internal" href="../../readme.html#initialize-projection-images">Initialize projection images:</a></li>
85+
<li class="toctree-l1"><a class="reference internal" href="../../readme.html#define-a-simple-projection-geometry">Define a simple projection geometry:</a></li>
86+
<li class="toctree-l1"><a class="reference internal" href="../../readme.html#create-phantom-and-project-into-proj">Create phantom and project into proj:</a></li>
87+
<li class="toctree-l1"><a class="reference internal" href="../../readme.html#forward-project">Forward project:</a></li>
8388
<li class="toctree-l1"><a class="reference internal" href="../../flextomo.html">Modules</a></li>
8489
<li class="toctree-l1"><a class="reference internal" href="../../changelog.html">Changelog</a></li>
8590
</ul>

‎docs/_modules/flextomo/phantom.html

+5
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,11 @@
8080

8181
<ul>
8282
<li class="toctree-l1"><a class="reference internal" href="../../readme.html">flexTOMO</a></li>
83+
<li class="toctree-l1"><a class="reference internal" href="../../readme.html#import">Import:</a></li>
84+
<li class="toctree-l1"><a class="reference internal" href="../../readme.html#initialize-projection-images">Initialize projection images:</a></li>
85+
<li class="toctree-l1"><a class="reference internal" href="../../readme.html#define-a-simple-projection-geometry">Define a simple projection geometry:</a></li>
86+
<li class="toctree-l1"><a class="reference internal" href="../../readme.html#create-phantom-and-project-into-proj">Create phantom and project into proj:</a></li>
87+
<li class="toctree-l1"><a class="reference internal" href="../../readme.html#forward-project">Forward project:</a></li>
8388
<li class="toctree-l1"><a class="reference internal" href="../../flextomo.html">Modules</a></li>
8489
<li class="toctree-l1"><a class="reference internal" href="../../changelog.html">Changelog</a></li>
8590
</ul>

‎docs/_modules/flextomo/projector.html

+5
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,11 @@
8080

8181
<ul>
8282
<li class="toctree-l1"><a class="reference internal" href="../../readme.html">flexTOMO</a></li>
83+
<li class="toctree-l1"><a class="reference internal" href="../../readme.html#import">Import:</a></li>
84+
<li class="toctree-l1"><a class="reference internal" href="../../readme.html#initialize-projection-images">Initialize projection images:</a></li>
85+
<li class="toctree-l1"><a class="reference internal" href="../../readme.html#define-a-simple-projection-geometry">Define a simple projection geometry:</a></li>
86+
<li class="toctree-l1"><a class="reference internal" href="../../readme.html#create-phantom-and-project-into-proj">Create phantom and project into proj:</a></li>
87+
<li class="toctree-l1"><a class="reference internal" href="../../readme.html#forward-project">Forward project:</a></li>
8388
<li class="toctree-l1"><a class="reference internal" href="../../flextomo.html">Modules</a></li>
8489
<li class="toctree-l1"><a class="reference internal" href="../../changelog.html">Changelog</a></li>
8590
</ul>

‎docs/_modules/index.html

+5
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,11 @@
8080

8181
<ul>
8282
<li class="toctree-l1"><a class="reference internal" href="../readme.html">flexTOMO</a></li>
83+
<li class="toctree-l1"><a class="reference internal" href="../readme.html#import">Import:</a></li>
84+
<li class="toctree-l1"><a class="reference internal" href="../readme.html#initialize-projection-images">Initialize projection images:</a></li>
85+
<li class="toctree-l1"><a class="reference internal" href="../readme.html#define-a-simple-projection-geometry">Define a simple projection geometry:</a></li>
86+
<li class="toctree-l1"><a class="reference internal" href="../readme.html#create-phantom-and-project-into-proj">Create phantom and project into proj:</a></li>
87+
<li class="toctree-l1"><a class="reference internal" href="../readme.html#forward-project">Forward project:</a></li>
8388
<li class="toctree-l1"><a class="reference internal" href="../flextomo.html">Modules</a></li>
8489
<li class="toctree-l1"><a class="reference internal" href="../changelog.html">Changelog</a></li>
8590
</ul>

‎docs/_sources/changelog.md.txt

+8-7
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,15 @@ All notable changes to this project will be documented in this file.
44
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
55
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
66

7-
## [Unreleased]
7+
## 0.1.0 - 2018-04-26
88
### Added
9-
- <insert-features-not-in-a-release-yet>
10-
### Fixed
11-
- <insert-bugs-fixed-not-in-a-release-yet>
9+
- Initial release
10+
- Added different calls to display functions
11+
- Added FISTA
12+
- Improved docs
13+
- Introduced new geometry classes
14+
- Added modules for polychromatic models
15+
- New examples
1216

13-
## 0.1.0 - YYYY-MM-DD
14-
### Added
15-
- Initial release.
1617

1718
[Unreleased]: https://www.github.com/teascavenger/flextomo/compare/v0.1.0...develop

‎docs/_sources/readme.md.txt

+12-4
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,25 @@ Before installing flexTOMO, please download and install [flexDATA](https://githu
1212

1313
Simply install with:
1414
```
15-
TODO
15+
conda create -n <your-environment> python=3.6
16+
conda install -c cicwi -c astra-toolbox/label/dev -c conda-forge -c owlas flextomo
1617
```
1718

1819
### Installing from source
1920

20-
To install flexTOMO, clone this GitHub project. Go to the cloned directory and run PIP installer:
21+
To install flexTOMO you will need the latest version of the ASTRA toobox (preferably development version).
22+
We also recommend to install [Xraylib](https://anaconda.org/conda-forge/xraylib) module using Anaconda from the Conda-Forge channel:
23+
24+
```
25+
conda install -c astra-toolbox/label/dev astra-toolbox
26+
conda install -c conda-forge xraylib
27+
```
28+
29+
To install flexTOMO, simply clone this GitHub project. Go to the cloned directory and run PIP installer:
2130
```
2231
git clone https://github.com/cicwi/flextomo.git
23-
cd flextomo
32+
cd flexdata
2433
pip install -e .
25-
```
2634

2735
## Running the examples
2836

‎docs/changelog.html

+15-24
Original file line numberDiff line numberDiff line change
@@ -81,15 +81,15 @@
8181

8282
<ul class="current">
8383
<li class="toctree-l1"><a class="reference internal" href="readme.html">flexTOMO</a></li>
84+
<li class="toctree-l1"><a class="reference internal" href="readme.html#import">Import:</a></li>
85+
<li class="toctree-l1"><a class="reference internal" href="readme.html#initialize-projection-images">Initialize projection images:</a></li>
86+
<li class="toctree-l1"><a class="reference internal" href="readme.html#define-a-simple-projection-geometry">Define a simple projection geometry:</a></li>
87+
<li class="toctree-l1"><a class="reference internal" href="readme.html#create-phantom-and-project-into-proj">Create phantom and project into proj:</a></li>
88+
<li class="toctree-l1"><a class="reference internal" href="readme.html#forward-project">Forward project:</a></li>
8489
<li class="toctree-l1"><a class="reference internal" href="flextomo.html">Modules</a></li>
8590
<li class="toctree-l1 current"><a class="current reference internal" href="#">Changelog</a><ul>
86-
<li class="toctree-l2"><a class="reference internal" href="#unreleased">Unreleased</a><ul>
91+
<li class="toctree-l2"><a class="reference internal" href="#id1">0.1.0 - 2018-04-26</a><ul>
8792
<li class="toctree-l3"><a class="reference internal" href="#added">Added</a></li>
88-
<li class="toctree-l3"><a class="reference internal" href="#fixed">Fixed</a></li>
89-
</ul>
90-
</li>
91-
<li class="toctree-l2"><a class="reference internal" href="#yyyy-mm-dd">0.1.0 - YYYY-MM-DD</a><ul>
92-
<li class="toctree-l3"><a class="reference internal" href="#id1">Added</a></li>
9393
</ul>
9494
</li>
9595
</ul>
@@ -163,27 +163,18 @@ <h1>Changelog<a class="headerlink" href="#changelog" title="Permalink to this he
163163
<p>All notable changes to this project will be documented in this file.</p>
164164
<p>The format is based on <a class="reference external" href="https://keepachangelog.com/en/1.0.0/">Keep a Changelog</a>,
165165
and this project adheres to <a class="reference external" href="https://semver.org/spec/v2.0.0.html">Semantic Versioning</a>.</p>
166-
<div class="section" id="unreleased">
167-
<h2><a class="reference external" href="https://www.github.com/teascavenger/flextomo/compare/v0.1.0...develop">Unreleased</a><a class="headerlink" href="#unreleased" title="Permalink to this headline"></a></h2>
166+
<div class="section" id="id1">
167+
<h2>0.1.0 - 2018-04-26<a class="headerlink" href="#id1" title="Permalink to this headline"></a></h2>
168168
<div class="section" id="added">
169169
<h3>Added<a class="headerlink" href="#added" title="Permalink to this headline"></a></h3>
170-
<ul>
171-
<li><div class="first"><insert-features-not-in-a-release-yet></div></li>
172-
</ul>
173-
</div>
174-
<div class="section" id="fixed">
175-
<h3>Fixed<a class="headerlink" href="#fixed" title="Permalink to this headline"></a></h3>
176-
<ul>
177-
<li><div class="first"><insert-bugs-fixed-not-in-a-release-yet></div></li>
178-
</ul>
179-
</div>
180-
</div>
181-
<div class="section" id="yyyy-mm-dd">
182-
<h2>0.1.0 - YYYY-MM-DD<a class="headerlink" href="#yyyy-mm-dd" title="Permalink to this headline"></a></h2>
183-
<div class="section" id="id1">
184-
<h3>Added<a class="headerlink" href="#id1" title="Permalink to this headline"></a></h3>
185170
<ul class="simple">
186-
<li>Initial release.</li>
171+
<li>Initial release</li>
172+
<li>Added different calls to display functions</li>
173+
<li>Added FISTA</li>
174+
<li>Improved docs</li>
175+
<li>Introduced new geometry classes</li>
176+
<li>Added modules for polychromatic models</li>
177+
<li>New examples</li>
187178
</ul>
188179
</div>
189180
</div>

‎docs/doctrees/changelog.doctree

-339 Bytes
Binary file not shown.

‎docs/doctrees/environment.pickle

-1.44 KB
Binary file not shown.

‎docs/doctrees/readme.doctree

-55 Bytes
Binary file not shown.

‎docs/flextomo.html

+5
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,11 @@
8282

8383
<ul class="current">
8484
<li class="toctree-l1"><a class="reference internal" href="readme.html">flexTOMO</a></li>
85+
<li class="toctree-l1"><a class="reference internal" href="readme.html#import">Import:</a></li>
86+
<li class="toctree-l1"><a class="reference internal" href="readme.html#initialize-projection-images">Initialize projection images:</a></li>
87+
<li class="toctree-l1"><a class="reference internal" href="readme.html#define-a-simple-projection-geometry">Define a simple projection geometry:</a></li>
88+
<li class="toctree-l1"><a class="reference internal" href="readme.html#create-phantom-and-project-into-proj">Create phantom and project into proj:</a></li>
89+
<li class="toctree-l1"><a class="reference internal" href="readme.html#forward-project">Forward project:</a></li>
8590
<li class="toctree-l1 current"><a class="current reference internal" href="#">Modules</a><ul>
8691
<li class="toctree-l2"><a class="reference internal" href="#module-flextomo.projector">flextomo.projector</a></li>
8792
<li class="toctree-l2"><a class="reference internal" href="#module-flextomo.phantom">flextomo.phantom</a></li>

‎docs/genindex.html

+5
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,11 @@
8181

8282
<ul>
8383
<li class="toctree-l1"><a class="reference internal" href="readme.html">flexTOMO</a></li>
84+
<li class="toctree-l1"><a class="reference internal" href="readme.html#import">Import:</a></li>
85+
<li class="toctree-l1"><a class="reference internal" href="readme.html#initialize-projection-images">Initialize projection images:</a></li>
86+
<li class="toctree-l1"><a class="reference internal" href="readme.html#define-a-simple-projection-geometry">Define a simple projection geometry:</a></li>
87+
<li class="toctree-l1"><a class="reference internal" href="readme.html#create-phantom-and-project-into-proj">Create phantom and project into proj:</a></li>
88+
<li class="toctree-l1"><a class="reference internal" href="readme.html#forward-project">Forward project:</a></li>
8489
<li class="toctree-l1"><a class="reference internal" href="flextomo.html">Modules</a></li>
8590
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
8691
</ul>

‎docs/index.html

+11-8
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,11 @@
8181

8282
<ul>
8383
<li class="toctree-l1"><a class="reference internal" href="readme.html">flexTOMO</a></li>
84+
<li class="toctree-l1"><a class="reference internal" href="readme.html#import">Import:</a></li>
85+
<li class="toctree-l1"><a class="reference internal" href="readme.html#initialize-projection-images">Initialize projection images:</a></li>
86+
<li class="toctree-l1"><a class="reference internal" href="readme.html#define-a-simple-projection-geometry">Define a simple projection geometry:</a></li>
87+
<li class="toctree-l1"><a class="reference internal" href="readme.html#create-phantom-and-project-into-proj">Create phantom and project into proj:</a></li>
88+
<li class="toctree-l1"><a class="reference internal" href="readme.html#forward-project">Forward project:</a></li>
8489
<li class="toctree-l1"><a class="reference internal" href="flextomo.html">Modules</a></li>
8590
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
8691
</ul>
@@ -154,14 +159,13 @@ <h1>Welcome to the documentation of flextomo!<a class="headerlink" href="#welcom
154159
<ul>
155160
<li class="toctree-l1"><a class="reference internal" href="readme.html">flexTOMO</a><ul>
156161
<li class="toctree-l2"><a class="reference internal" href="readme.html#getting-started">Getting Started</a></li>
157-
<li class="toctree-l2"><a class="reference internal" href="readme.html#running-the-examples">Running the examples</a></li>
158-
<li class="toctree-l2"><a class="reference internal" href="readme.html#modules">Modules</a></li>
159-
<li class="toctree-l2"><a class="reference internal" href="readme.html#authors-and-contributors">Authors and contributors</a></li>
160-
<li class="toctree-l2"><a class="reference internal" href="readme.html#how-to-contribute">How to contribute</a></li>
161-
<li class="toctree-l2"><a class="reference internal" href="readme.html#license">License</a></li>
162-
<li class="toctree-l2"><a class="reference internal" href="readme.html#acknowledgments">Acknowledgments</a></li>
163162
</ul>
164163
</li>
164+
<li class="toctree-l1"><a class="reference internal" href="readme.html#import">Import:</a></li>
165+
<li class="toctree-l1"><a class="reference internal" href="readme.html#initialize-projection-images">Initialize projection images:</a></li>
166+
<li class="toctree-l1"><a class="reference internal" href="readme.html#define-a-simple-projection-geometry">Define a simple projection geometry:</a></li>
167+
<li class="toctree-l1"><a class="reference internal" href="readme.html#create-phantom-and-project-into-proj">Create phantom and project into proj:</a></li>
168+
<li class="toctree-l1"><a class="reference internal" href="readme.html#forward-project">Forward project:</a></li>
165169
<li class="toctree-l1"><a class="reference internal" href="flextomo.html">Modules</a><ul>
166170
<li class="toctree-l2"><a class="reference internal" href="flextomo.html#module-flextomo.projector">flextomo.projector</a></li>
167171
<li class="toctree-l2"><a class="reference internal" href="flextomo.html#module-flextomo.phantom">flextomo.phantom</a></li>
@@ -170,8 +174,7 @@ <h1>Welcome to the documentation of flextomo!<a class="headerlink" href="#welcom
170174
</ul>
171175
</li>
172176
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a><ul>
173-
<li class="toctree-l2"><a class="reference internal" href="changelog.html#unreleased">Unreleased</a></li>
174-
<li class="toctree-l2"><a class="reference internal" href="changelog.html#yyyy-mm-dd">0.1.0 - YYYY-MM-DD</a></li>
177+
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id1">0.1.0 - 2018-04-26</a></li>
175178
</ul>
176179
</li>
177180
</ul>

‎docs/modules.html

+5
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,11 @@
8080

8181
<ul>
8282
<li class="toctree-l1"><a class="reference internal" href="readme.html">flexTOMO</a></li>
83+
<li class="toctree-l1"><a class="reference internal" href="readme.html#import">Import:</a></li>
84+
<li class="toctree-l1"><a class="reference internal" href="readme.html#initialize-projection-images">Initialize projection images:</a></li>
85+
<li class="toctree-l1"><a class="reference internal" href="readme.html#define-a-simple-projection-geometry">Define a simple projection geometry:</a></li>
86+
<li class="toctree-l1"><a class="reference internal" href="readme.html#create-phantom-and-project-into-proj">Create phantom and project into proj:</a></li>
87+
<li class="toctree-l1"><a class="reference internal" href="readme.html#forward-project">Forward project:</a></li>
8388
<li class="toctree-l1"><a class="reference internal" href="flextomo.html">Modules</a></li>
8489
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
8590
</ul>

‎docs/py-modindex.html

+5
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,11 @@
8383

8484
<ul>
8585
<li class="toctree-l1"><a class="reference internal" href="readme.html">flexTOMO</a></li>
86+
<li class="toctree-l1"><a class="reference internal" href="readme.html#import">Import:</a></li>
87+
<li class="toctree-l1"><a class="reference internal" href="readme.html#initialize-projection-images">Initialize projection images:</a></li>
88+
<li class="toctree-l1"><a class="reference internal" href="readme.html#define-a-simple-projection-geometry">Define a simple projection geometry:</a></li>
89+
<li class="toctree-l1"><a class="reference internal" href="readme.html#create-phantom-and-project-into-proj">Create phantom and project into proj:</a></li>
90+
<li class="toctree-l1"><a class="reference internal" href="readme.html#forward-project">Forward project:</a></li>
8691
<li class="toctree-l1"><a class="reference internal" href="flextomo.html">Modules</a></li>
8792
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
8893
</ul>

0 commit comments

Comments
 (0)