|
| 1 | +# Ubuntu Installation |
| 2 | + |
| 3 | + |
| 4 | + |
| 5 | +# Introduction |
| 6 | +This guide will guide you through the installation process for the **ALL Arduino Nano 33 BLE Sense Classifier** Project. |
| 7 | + |
| 8 | +<font color='red'>DEVELOPER TO EXPLAIN/UPDATE THE PROJECT DETAILS</font> |
| 9 | + |
| 10 | + |
| 11 | + |
| 12 | +# Prerequisites |
| 13 | +You will need to ensure you have the following prerequisites installed and setup. |
| 14 | + |
| 15 | +<font color='red'>DEVELOPER TO EXPLAIN/UPDATE THE PREQUISITE DETAILS</font> |
| 16 | + |
| 17 | + |
| 18 | + |
| 19 | +# Operating System |
| 20 | +The ALL Arduino Nano 33 BLE Sense Classifier Jupyter Notebook supports the following operating system(s). |
| 21 | + |
| 22 | +<font color='red'>DEVELOPER TO LIST COMPATIBLE OPERATING SYSTEM(S). MUST BE TESTED BEFORE LISTING</font> |
| 23 | + |
| 24 | + |
| 25 | + |
| 26 | +# Software |
| 27 | +The ALL Arduino Nano 33 BLE Sense Classifier Jupyter Notebook project uses the following libraries. |
| 28 | + |
| 29 | +<font color='red'>DEVELOPER TO LIST SOFTWARE LIBRARIES USED</font> |
| 30 | + |
| 31 | + |
| 32 | + |
| 33 | +# Installation |
| 34 | +You are now ready to install the ALL Arduino Nano 33 BLE Sense Classifier Project. |
| 35 | + |
| 36 | +## Clone the repository |
| 37 | + |
| 38 | +Clone the [ALL Arduino Nano 33 BLE Sense Classifier](https://github.com/AMLResearchProject/ALL-Arduino-Nano-33-BLE-Sense-Classifier " ALL Arduino Nano 33 BLE Sense Classifier") repository from the [Peter Moss Acute Myeloid & Lymphoblastic Leukemia AI Research Project](https://github.com/AMLResearchProject "Peter Moss Acute Myeloid & Lymphoblastic Leukemia AI Research Project") Github Organization. |
| 39 | + |
| 40 | +To clone the repository and install the project, make sure you have Git installed. Now navigate to the directory you would like to clone the project to and then use the following command. |
| 41 | + |
| 42 | +``` bash |
| 43 | + git clone https://github.com/AMLResearchProject/ALL-Arduino-Nano-33-BLE-Sense-Classifier.git |
| 44 | +``` |
| 45 | + |
| 46 | +This will clone the ALL Arduino Nano 33 BLE Sense Classifier repository and move the cloned repository to the agents directory in the HIAS project (components/agents/mqtt/). |
| 47 | + |
| 48 | +``` bash |
| 49 | + ls |
| 50 | +``` |
| 51 | + |
| 52 | +Using the ls command in your home directory should show you the following. |
| 53 | + |
| 54 | +``` bash |
| 55 | + ALL-Arduino-Nano-33-BLE-Sense-Classifier |
| 56 | +``` |
| 57 | + |
| 58 | +Navigate to the **ALL-Arduino-Nano-33-BLE-Sense-Classifier** directory, this is your project root directory for this tutorial. |
| 59 | + |
| 60 | +### Developer forks |
| 61 | + |
| 62 | +Developers from the Github community that would like to contribute to the development of this project should first create a fork, and clone that repository. For detailed information please view the [CONTRIBUTING](https://github.com/AMLResearchProject/ALL-Arduino-Nano-33-BLE-Sense-Classifier/blob/master/CONTRIBUTING.md "CONTRIBUTING") guide. You should pull the latest code from the development branch. |
| 63 | + |
| 64 | +``` bash |
| 65 | + git clone -b "1.0.0" https://github.com/AMLResearchProject/ALL-Arduino-Nano-33-BLE-Sense-Classifier.git |
| 66 | +``` |
| 67 | + |
| 68 | +The **-b "1.0.0"** parameter ensures you get the code from the latest master branch. Before using the below command please check our latest master branch in the button at the top of the project README. |
| 69 | + |
| 70 | +## Installation script |
| 71 | +All software requirements are included in **scripts/install.sh**. You can run this file on your machine from the project root in terminal. Use the following command: |
| 72 | + |
| 73 | + sh scripts/install.sh |
| 74 | + |
| 75 | +<font color='red'>DEVELOPER TO PROVIDE FULL INSTALLATION INSTRUCTIONS</font> |
| 76 | + |
| 77 | + |
| 78 | + |
| 79 | +## Configuration |
| 80 | + |
| 81 | +All configuration can be found in the **configuration/config.json** file. |
| 82 | + |
| 83 | +<font color='red'>DEVELOPER TO EDIT CONFIG FILE AND PROVIDE FULL DESCRIPTION OF CONFIGURATION</font> |
| 84 | + |
| 85 | + |
| 86 | + |
| 87 | +# Contributing |
| 88 | +Asociación de Investigacion en Inteligencia Artificial Para la Leucemia Peter Moss encourages and welcomes code contributions, bug fixes and enhancements from the Github community. |
| 89 | + |
| 90 | +Please read the [CONTRIBUTING](https://github.com/AMLResearchProject/ALL-Arduino-Nano-33-BLE-Sense-Classifier/blob/main/CONTRIBUTING.md "CONTRIBUTING") document for a full guide to forking our repositories and submitting your pull requests. You will also find our code of conduct in the [Code of Conduct](https://github.com/AMLResearchProject/ALL-Arduino-Nano-33-BLE-Sense-Classifier/blob/main/CODE-OF-CONDUCT.md) document. |
| 91 | + |
| 92 | +## Contributors |
| 93 | +- [Adam Milton-Barker](https://www.leukemiaairesearch.com/association/volunteers/adam-milton-barker "Adam Milton-Barker") - [Asociación de Investigacion en Inteligencia Artificial Para la Leucemia Peter Moss](https://www.leukemiaresearchassociation.ai "Asociación de Investigacion en Inteligencia Artificial Para la Leucemia Peter Moss") President/Founder & Lead Developer, Sabadell, Spain |
| 94 | + |
| 95 | + |
| 96 | + |
| 97 | +# Versioning |
| 98 | +We use [SemVer](https://semver.org/) for versioning. |
| 99 | + |
| 100 | + |
| 101 | + |
| 102 | +# License |
| 103 | +This project is licensed under the **MIT License** - see the [LICENSE](https://github.com/AMLResearchProject/ALL-Arduino-Nano-33-BLE-Sense-Classifier/blob/main/LICENSE "LICENSE") file for details. |
| 104 | + |
| 105 | + |
| 106 | + |
| 107 | +# Bugs/Issues |
| 108 | +We use the [repo issues](https://github.com/AMLResearchProject/ALL-Arduino-Nano-33-BLE-Sense-Classifier/issues "repo issues") to track bugs and general requests related to using this project. See [CONTRIBUTING](https://github.com/AMLResearchProject/ALL-Arduino-Nano-33-BLE-Sense-Classifier/blob/main/CONTRIBUTING.md "CONTRIBUTING") for more info on how to submit bugs, feature requests and proposals. |
0 commit comments