Ubuntu Installation
Introduction
This installation guide provides a step by step guide that takes you through the installation process for the HIASCDI.
Please Note
HIASCDI is installed during the installation of HIAS Core v3 this documentation is solely for reference
Prerequisites
For this project you will need to ensure you have the following prerequisites installed and running.
HIAS Core
HIASCDI is a core component of the HIAS - Hospital Intelligent Automation Server. Before beginning this tutorial you should complete the HIAS installation guide and have your HIAS server online.
Operating System
The HIASCDI supports the following operating system(s):
- Ubuntu 20.04 LTS
Installation
You are now ready to install the HIASCDI software.
Clone the repository
Clone the HIASCDI repository from the Asociación de Investigacion en Inteligencia Artificial Para la Leucemia Peter Moss Github Organization.
To clone the repository and install the project, make sure you have Git installed. Now navigate to your HIAS installation project root and then use the following command.
git clone https://github.com/AIIAL/HIASCDI.git
mv HIASCDI components/hiascdi/
This will clone the HIASCDI repository and move the cloned repository to the components directory in the HIAS project (components/hiascdi/).
cd components/
ls
Using the ls command in your HIAS project root directory should show you the following.
hiascdi
Navigate to the HIAS/components/hiascdi/ directory in your HIAS project root, this is your project root directory for this tutorial.
Developer forks
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 guide. You should pull the latest code from the development branch.
git clone -b "develop" https://github.com/AIIAL/HIASCDI.git
The -b "develop" parameter ensures you get the code from the develpo branch.
Start The Service
You will now create a service that will run and manage your HIASCDI installation. Making sure you are in the HIAS project root, use the following command:
sh components/scripts/service.sh
API Documentation
Please review the HIASCDI API Usage Guide for details on how to use the HIASCDI API.
Contributing
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.
Ways to contribute
The following are ways that you can contribute to this project:
Please read the CONTRIBUTING document for a contribution guide.
You can also join in with, or create, a discussion in our Github Discussions area.
Contributors
All contributors to this project are listed below.
- Adam Milton-Barker - Asociación de Investigacion en Inteligencia Artificial Para la Leucemia Peter Moss President/Founder & Lead Developer, Sabadell, Spain
Versioning
We use SemVer for versioning.
License
This project is licensed under the MIT License - see the LICENSE file for details.
Bugs/Issues
You use the repo issues to track bugs and general requests related to using this project. See CONTRIBUTING for more info on how to submit bugs, feature requests and proposals.