Update documentation.html (#2)

- Update documentation.html (3a5384131cc1ec7790633941b124f78f229b6602)


Co-authored-by: Pablo Romero Agudo <[email protected]>

documentation.html

@@ -38,6 +38,101 @@
                 <p>The installation package includes all servers. However, the Orthanc server is a manual installation. The installation instructions can be found below.</p>
             </section>
 
+            <section id="PARROT-local-application">
+                <h2>PARROT Local Application</h2>
+                <p>
+                    The <strong>PARROT Local Application</strong> is a web application (that means that its user interface runs in your web browser) that you can install and run locally on your computer.
+                    The application provides different modules that allow you to
+                </p>
+                <ul>
+                    <li>
+                        <p>run ML-models.</p>
+                    </li>
+    
+                    <li>
+                        <p>visualize CT and MR images.</p>
+                    </li>
+      
+                    <li>
+                        <p>visualize, predict or modify segmentation information.</p>
+                    </li>
+      
+                    <li>
+                        <p>visualize, evaluate, and compare dose treatment plans.</p>
+                    </li>
+                </ul>
+                <p>
+                    You can load patient studies into the application in the form of DICOM files. Internally, the application uses an nginx server to run the web application, a Python server for the
+                    prediction of the integrated trained AI model, and an Orthanc server for the storage of the study data. The installation package includes all servers. However, the Orthanc server is a
+                    manual installation.
+                </p>
+                <p class="warning">
+                    ⚠ The Orthanc server will run on <a target="_blank" href="http://localhost:8042/">port 8042</a> of your local computer and
+                    the nginx server on <a target="_blank" href="http://localhost:2000/">port 2000</a>.
+                </p>
+            </section>
+
+            <section id="stoping-the-application">
+                <h2>Stoping the application</h2>
+                <ul>
+                    <li>
+                        <p>
+                            The nginx server will continue running, even when you close the web browser window. To completely stop the server, double click the <strong>'Stop_PARROT.bat'</strong> file in the <strong>'parrot'</strong> folder (or stop the nginx processes in the Task Manager).
+                        </p>
+                    </li>
+                    <li>
+                        <p>
+                            The Orthanc server runs as a Windows service and has to be stopped in the <strong>'Task Manager'</strong> (in the tab <strong>'Services'</strong>). Don't forget to start the service again when you want to use the <strong>'PARROT application'</strong>.
+                        </p>
+                    </li>
+                </ul>
+            </section>
+
+            <section id="folder-structure">
+                <h2>Folder Structure</h2>
+                <p>The <strong>'parrot'</strong> folder contains the following files:</p>
+                <ul>
+                    <li>
+                        <p><strong>'aiIntegration'</strong> contains the integrated trained AI models, the Python server environment and the API server directories.</p>
+                    </li>
+                    <li>
+                        <p><strong>'dist'</strong> contains the PARROT web application.</p>
+                    </li>
+                    <li>
+                        <p><strong>'logs'</strong> contains the log files of the nginx server.</p>
+                    </li>
+                    <li>
+                        <p><strong>'temp'</strong> contains the temporary files of nginx.</p>
+                    </li>
+      
+                    <li>
+                        <p><strong>'tempai'</strong> contains the results of running the Python code. The user can configure the path for AI integration.</p>
+                    </li>
+      
+                    <li>
+                        <p><strong>'favicon.ico'</strong> contains the the image of the application.</p>
+                    </li>
+                    <li>
+                        <p><strong>'License'</strong> contains the License of the application.</p>
+                    </li>
+                    <li>
+                        <p><strong>'nginx.exe'</strong> starts the nginx server (see the instructions above).</p>
+                    </li>
+                    <li>
+                        <p><strong>'script-installer.iss'</strong> contains the script to create the installer.</p>
+                    </li>
+                    <li>
+                        <p><strong>'Start_PARROT.bat'</strong> start the nginx server (see the instructions above).</p>
+                    </li>
+                    <li>
+                        <p><strong>'Stop_PARROT.bat'</strong> stop the ngnix server (see the instructions above).</p>
+                    </li>
+                    <li>
+                        <p><strong>'unins000.exe'</strong> uninstalls the application from the computer.</p>
+                    </li>
+                </ul>
+            </section>
+
             <section id="study-management">
                 <h2>Study Management</h2>
                 <p>Users can import patient data from this screen to a local Orthanc daemon—a lightweight, standalone DICOM server, which ensures the confidentiality of patient files. A list of patient data present in the Orthanc server is displayed with summarized information. Users can load the data into the app by clicking on the Load button. The left icon displays more complete information from DICOM tags and users can delete a patient study from the server with the red arrow on the right.</p>