trixi 0.1

Package to log visualizations and experiments, e.g. with visdom

Copyright (c) 2017 Medical Image Computing Group, DKFZ

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.


Description: # Install
Install Dependencies
```
pip install -r requirements.txt
```

If you want to use the full functionallity e.g. any of the PyTorch loggers or the Experiment class:
```
pip install -r requirements_full.txt
```

Install trixi:
```
git clone https://github.com/MIC-DKFZ/trixi.git
cd trixi
pip install -e .
```

# Sphinx Setup

### Setup

Install Sphinx:
`pip install sphinx`

Generate Api-docs:
`path/to/PROJECT/doc$ sphinx-apidoc -f -o . ..`

Open index.html:
`firefox path/to/PROJECT/doc/_build/html/index.html`

### Notes
* rerun make html each time existing modules are updated
* DO NOT forget indent or blank lines
* Code with no classes or functions is not automatically captured using apidoc


### Example Documentation

This follows the Google style docstring guidelines:

def show_image(self, image, name, file_format=".png", **kwargs):
"""
This function shows an image.

Args:
image(np.ndarray): image to be shown
name(str): image title
"""


**IMPORTANT NOTE**: Somehow pytorch and lasagne/theano do not play nicely together. So if you
import lasagne/theano and trixi (which imports pytorch if you have it installed),
your program will get stuck. So you can only use trixi with lasagne/theano if you do not
have pytorch installed. If you need both you can use virtual_envs.

# Use on remote server in same network
Simple run visdom on remote server and then on your local computer go to `MY_REMOTE_SERVER_NAME:8080`.

# Use on remote server in different network

If you want to run trixi on a remote server, but show the results locally
you can do:

```
# On local computer:
ssh -N -f -L localhost:8080:localhost:8080 USERNAME@REMOTE_SERVERNAME

# On remote server:
python -m visdom.server -port 8080
python my_random_trixi_script.py
```

Now on your local computer you can go to `localhost:8080` and see the visdom dashboard.

Platform: UNKNOWN