Commit 5bff5b44 authored by Chris Coughlin's avatar Chris Coughlin

Added developer links & switched theme to address small screen issue

parent cb50299e
# Developers
## Git Repositories
* Myriad [https://gitlab.com/ccoughlin/datareader.git](https://gitlab.com/ccoughlin/datareader.git)
* Myriad Desktop [https://gitlab.com/ccoughlin/MyriadDesktop.git](https://gitlab.com/ccoughlin/MyriadDesktop.git)
* Myriad Trainer [https://gitlab.com/ccoughlin/MyriadTrainer.git](https://gitlab.com/ccoughlin/MyriadTrainer.git)
## Developer Documentation
* [Java API documents](http://myrdocs.azurewebsites.net/api/)
* [Code Samples](https://emphysic.com/myriad/sample-code/)
\ No newline at end of file
......@@ -4,4 +4,19 @@
In 2016 [NASA funded](http://sbir.nasa.gov/SBIR/abstracts/16/sbir/phase1/SBIR-16-1-H13.01-8360.html) the development of a Myriad-based system for automatically detecting indications of structural damage in large [Nondestructive Testing (NDT)](https://en.wikipedia.org/wiki/Nondestructive_testing) datasets. We've put together a demonstration of this system that goes all the way from picking training data to searching for damage:
[![Training / Testing Models](img/bigvid.png)](https://emphysic.wistia.com/medias/sbbft90a67)
\ No newline at end of file
[![Training / Testing Models](img/bigvid.png)](https://emphysic.wistia.com/medias/sbbft90a67)
## Potential Applications
* [Face detection](https://en.wikipedia.org/wiki/Face_detection)
* [Pedestrian tracking](http://www.bmva.org/apps:pedestrian)
* Object identification
* Obstacle avoidance
## Features
* A variety of signal/image processing operations and feature detection operations
* Machine learning capabilities courtesy [Smile](http://haifengl.github.io/smile/) and [Apache Mahout](http://mahout.apache.org/)
* Fault-tolerant concurrency courtesy [Akka](http://akka.io/)
* Experimental support for hardware acceleration (GPU, Xeon Phi, etc.) courtesy [Aparapi](http://aparapi.github.io/)
## License
Licensed under the [Apache 2.0 License](http://www.apache.org/licenses/LICENSE-2.0.txt)
\ No newline at end of file
......@@ -7,14 +7,14 @@ Myriad will run anywhere where Java 8 is available. The current minimum require
* Disk: 126MB
* Processor: Pentium 2 266MHz or better
Full details on Java 8 requirements are available from [Oracle's Java site](http://www.oracle.com/technetwork/java/javase/certconfig-2095354.html) . Myriad has been tested to compile and run on Windows 7, Windows 10, Linux, TrueOS, OpenBSD, and FreeBSD.
Full details on Java 8 requirements are available from [Oracle's Java site](http://www.oracle.com/technetwork/java/javase/certconfig-2095354.html) . Myriad has been tested to compile and run on Windows 7, Windows 10, various Linux distributions, TrueOS, OpenBSD, and FreeBSD.
## Dependencies
* JDK 8, either [Oracle Java](http://java.sun.com) or [OpenJDK](http://openjdk.java.net/) . The Myriad library, Myriad Trainer and Myriad Desktop have not undergone extensive testing under OpenJDK but are known to compile and run.
* [Apache Maven](http://maven.apache.org)
* (Optional) [Git](http://git-scm.com)
Maven requires the environment variable `JAVA_HOME` to be set. Under Windows, press the Windows key to begin searching and start typing "environment" to bring up the System Properties dialog. Click the "Environment Variables..." button and add a new User Variable `JAVA_HOME` that points to the root folder where the JDK was installed e.g. `C:\Program Files\Java\jdk1.8.0_101`.
Maven requires the environment variable `JAVA_HOME` to be set. Under Windows, press the Windows key to begin searching and start typing "environment" to bring up the System Properties dialog. Click the `Environment Variables...` button and add a new User Variable `JAVA_HOME` that points to the root folder where the JDK was installed e.g. `C:\Program Files\Java\jdk1.8.0_101`.
POSIX-style operating systems such as Linux or OpenBSD will vary on how to set environment variables. In the bash shell for example this can be done by adding the environment variable to the user’s `.bashrc file`, e.g. `export JAVA_HOME=/home/username/jdk`. In csh the equivalent is `setenv JAVA_HOME /home/username/jdk` .
......@@ -42,6 +42,8 @@ Myriad relies on an external dynamic library to access hardware. The Myriad sou
For assistance using OpenCL on other operating systems, please [contact Emphysic](https://emphysic.com/contact-us/). OpenCL is an optional component of Myriad; applications written using Myriad (including the GUI tools) will run perfectly well without OpenCL support.
## Building Myriad
Myriad is distributed as an [Apache Maven](https://maven.apache.org/) project.
Most of the Myriad dependencies will be automatically downloaded and installed, but several third-party libraries require an extra step. These libraries are in the `libs` folder, which also contains shell scripts for downloading and installing these libraries automatically. Windows users can run `installdeps.bat` and Linux/FreeBSD/OS X users can run `installdeps.sh`.
Alternatively if you would prefer to perform the steps manually, issue the following commands:
......
......@@ -2,6 +2,8 @@ site_name: Myriad
pages:
- Main: 'index.md'
- Installation: 'install.md'
- Myriad Trainer: 'trainer.md'
- Myriad Desktop: 'desktop.md'
theme: readable
\ No newline at end of file
- Developers: 'developers.md'
- Tools:
- Myriad Trainer: 'trainer.md'
- Myriad Desktop: 'desktop.md'
theme: readthedocs
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment