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

Use more markup in the readme. #1

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Use more markup in the readme. #1

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
03a7bc6
Use more markup in the readme.
HolgerPeters Nov 30, 2016
233c4cf
markup `NB_MAXNODE` as preformatted text
HolgerPeters Nov 30, 2016
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
72 changes: 44 additions & 28 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,46 +2,62 @@

Interface to NeuroBayes(R) for academic purpose

The NeuroBayes package is available under the NeuroBayes license from Blue Yonder GmbH.
Please contact [email protected] for general information and for information about the license.
The NeuroBayes package is available under the NeuroBayes license from Blue
Yonder GmbH. Please contact [email protected] for general information
and for information about the license.

This repository provides the C++ Interface of the NeuroBayes package. You can
only build this project if you obtained the NeuroBayes licence and NeuroBayes
Core library from Blue Yonder GmbH.

The NeuroBayes C++ Interface is usually already shipped with the NeuroBayes
package. The NeuroBayes Core library does only depenend on a very small set of
system libraries like `libc` and `libgfortran`. The NeuroBayes C++ Interface
depends on `libstdc++`. It may be necessary to recompile the C++ Interface in
the future to support new platforms, hence Blue Yonder GmbH decided to release
the source code of the C++ Interface under the MIT licence for the convenience
of the NeuroBayes user community (in particular for high energy physics
experiments).

This repository provides the C++ Interface of the NeuroBayes package. You can only build this project if you
obtained the NeuroBayes licence and NeuroBayes Core library from Blue Yonder GmbH.
# Build process and installation

The NeuroBayes C++ Interface is usually already shipped with the NeuroBayes package.
The NeuroBayes Core library does only depenend on a very small set of system libraries like libc and libgfortran,
on the other hand the NeuroBayes C++ Interface depends on libstdc++.
It may be necessary to recompile the C++ Interface in the future to support new platforms,
hence Blue Yonder GmbH decided to release the source code of the C++ Interface under the MIT licence for the convinience
of the NeuroBayes user community (in particular for high energy physics experiments).
Extract the NeuroBayes Core shared library named `libNeuroBayesCore_shared.so`
from the package you obtained from Blue Yonder GmbH and copy it into the
previously empty directory `./core`.

To build the NeuroBayes C++ Interface, run:

# Build process and installation
* Extract the NeuroBayes Core shared library named libNeuroBayesCore\_shared.so from the package you obtained from Blue Yonder GmbH and copy it into the previously empty directory core.
* cd build/
* cmake ../
* make
cd build/
cmake ../
make


## Building rpm, deb or tgz packages
Optionally you can build rpm, deb and tgz packages using
* make package
Additional third-party libraries are required to do so.

Optionally you can build rpm, deb and tgz packages using `make package`.
Additional third-party libraries are required to do so.

## Maxnode
The NeuroBayes Core library is optimized for a maximum number of nodes.
The maximum number of nodes is printed by the NeuroBayes Teacher
at the start of the program e.g. execute the minimaltest executable and search for NB\_MAXNODE.
The default number is 100. If your library is optimized for a different number of nodes,
you have to provide the correct number using an environment variable named MAXNODE\_PREPRO.
during the build process e.g. MAXNODE\_PREPRO=200 cmake ../

The NeuroBayes Core library is optimized for a maximum number of nodes. The
maximum number of nodes is printed by the NeuroBayes Teacher at the start of
the program e.g. execute the minimaltest executable and search for `NB_MAXNODE`
in its output.

The default number is 100. If your library is optimized for a different number
of nodes, you have to provide the correct number using an environment variable
named `MAXNODE_PREPRO`. during the build process e.g.

MAXNODE_PREPRO=200 cmake ../


## Tests
To verify the correctness of your executable, you can execute the following test suits:
* cd build
* ./minimaltest
* ./interfacetest

To verify the correctness of your executable, you can execute the following
test suits:

cd build
./minimaltest
./interfacetest

The minimaltest provides also a minimal example to get you started.