Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify beginning of user guide (loading data) #430

Merged
merged 2 commits into from
Jun 14, 2018
Merged

Clarify beginning of user guide (loading data) #430

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6255294
Fix build without FreeImage
Jun 14, 2018
f0d2637
Clarify beginning of user guide (loading data)
Jun 14, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions brayns/common/utils/ImageUtils.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@

#include <brayns/common/renderer/FrameBuffer.h>

#ifdef BRAYNS_USE_FREEIMAGE
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not user guide 😄

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's why this commit is called "Fix build without FreeImage" ;-)

Copy link
Contributor

@rolandjitsu rolandjitsu Jun 14, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was looking at the PR name, and it can be misleading when you search your PR history, since you probably squash the commits into a single one.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not going to squash the commits, and I don't want to open a separate PR for such a small fix...


namespace
{
template <class T>
Expand Down Expand Up @@ -108,3 +110,5 @@ std::string getBase64Image(FrameBuffer& frameBuffer, const std::string& format,
}
}
}

#endif
26 changes: 16 additions & 10 deletions doc/UserGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,32 @@
# Brayns user guide

## Data sources
## Basic usage

### Morphologies
Brayns takes any number of files or folders as argument. To open a single file:
```
braynsViewer model.obj
```

#### Loading data
Alternatively, to open all supported files in a folder:
```
braynsViewer ~/datasets/
```

The generic (optional) command line argument ```--input-paths``` can be used to specify files and/or folders to load data from.
## Neurons

#### Loading morphologies
### Loading individual morphologies

SWC or H5 morphology files (supported by the [Brion](https://github.com/BlueBrain/Brion) library) can be loaded
easily.
SWC or H5 morphology files (supported by the
[Brion](https://github.com/BlueBrain/Brion) library) can be loaded easily.

```
braynsViewer ~/morphologies
```

### Loading a circuit
### Loading a NEURON simulation

BlueConfig or CircuitConfig files (supported by the Brion library) can be
loaded. The ```--circuit-targets``` command line argument specified the circuit target
loaded. The ```--circuit-targets``` command line argument specifies the circuit target
(or multiples separated by comma), and the ```--circuit-report``` command line
argument specifies the simulation report to be rendered.

Expand Down Expand Up @@ -55,7 +61,7 @@ Example of how to load 10% of the circuit:
braynsViewer ~/circuits/BlueConfig --circuit-density 10
```

### Loading a NEST circuit
### Loading a NEST simulation

The ```--nest-config``` command line argument define the NEST circuit to be loaded by
Brayns. The ```--nest-report``` command line argument specifies the report to be
Expand Down