Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
pakitochus committed Nov 21, 2017
1 parent 96a5990 commit feff517
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Expand Up @@ -6,6 +6,11 @@ Functional brain image synthesis using the KDE or MVN distribution. Currently in
`brainSimulator` is a brain image synthesis procedure intended to generate a new image set that share characteristics with an original one. The system focuses on nuclear imaging modalities such as PET or SPECT brain images. It analyses the dataset by applying PCA to the original dataset, and then model the distribution of samples in the projected eigenbrain space using a Probability Density Function (PDF) estimator. Once the model has been built, anyone can generate new coordinates on the eigenbrain space belonging to the same class, which can be then projected back to the image space.

## Use
First of all, install the package via pypi with:
```
pip install brainsimulator
```

With the new version, the whole interface has been switched to an object. This allows to train the model once and then perform as many sample drawings as required.
```python
#navigate to the folder where simulator.py is located
Expand Down
11 changes: 11 additions & 0 deletions docs/overview.rst
Expand Up @@ -7,6 +7,17 @@ BrainSimulator's Overview
:align: center
:alt: Schema of the synthesis methodology.

Installation
-------------------
`brainSimulator` is now available via `pypi` and can be installed directly from::

pip install brainSimulator

Alternatively, download the package, uncompress and execute::

cd /path/to/uncompressed/brainSimulator/
python setup.py install

Quickstart
-------------------
The "stack"
Expand Down

0 comments on commit feff517

Please sign in to comment.