pchlap/planchecker repository overview

⁠PlanChecker

This repository contains the source code for the redevelopment of the PlanChecker software at Liverpool and Macarthur Cancer Therapy Centre.

This project is currently in the design phase. This README should be populated with details on the structure of the project as it becomes clear.

⁠Project Structure

See docs/design for initial UML diagrams.

⁠Development

Dockerfile contains instructions to build an image with all required dependencies. An up-to-date version of this image is maintained on Docker Hub. The easist way to get started with development on PlanChecker is to use Docker and Visual Studio Code.

⁠Setting up development environment

1. Install Docker⁠
2. Install Visual Studio Code⁠
3. Clone this source code repository: git clone https://[Your-BitBucket-Username]@bitbucket.org/swscsmedphys/planchecker.git
4. Open Visual Studio Code, and open a remote window by pressing the green icon in the very bottom right hand corner.
5. Select Remote-Containers: Open Folder in Container...
6. Browse to and open the PlanChecker directory you cloned in step 3.
7. Select the PlanChecker Development environment.
8. This will reopen the Visual Studio Code window, but this time it will open inside the docker container environment which has everything you need preinstalled to begin developing!

⁠Running the application

TODO

⁠Authors

• Aitang Xing - [email protected]⁠
• Phillip Chlap - [email protected]⁠