Merge pull request #42 from oss-slu/projects-fall2023

Projects fall2023

Author: kungfuchicken

docs/portfolio.md

@@ -18,19 +18,19 @@ We are currently accepting project requests. You can submit your request via thi
 ## Current Capstone Projects
 
 <!-- - ![Alt](project_name/100x100.png) **Project Name** One-sentence description of the purpose of the project -->
-- [DADS (Database of Arithmetic Dynamical Systems)](project_dads/about) - The goal of this project is to create a flexible, web-based, search-driven user interface for a database of arithmetic dynamical systems
+- **[DADS (Database of Arithmetic Dynamical Systems)](project_dads/about)** - The goal of this project is to create a flexible, web-based, search-driven user interface for a database of arithmetic dynamical systems
 - ![DEER](project_deer/deer_100.jpg) **[Data Entry & Exhibition for Rerum](project_deer/about)** A designer's framework for non-destructive annotation and template rendering for distributed digital resources and collections.
-- Drone World
-- Gallery of Glosses
-- MeltShiny
-- ![Mouser](project_mouser/100x100.png) [**Mouser**](project_mouser/about) - This software is used for tracking the data of animal experiments.
+- **[Drone World](project_droneworld/about)** - DroneWorld is a platform for testing small unmanned aerial systems (sUAS) applications by simulating realistic test scenarios based on specified requirements.
+- **[Gallery of Glosses](./project_gallery_of_glosses/about)** - Interfaces to view and manage Glosses. 
+- **[MeltShiny](project_meltshiny/about)** - automates the analysis and visualization of DNA melting curves for researchers in chemistry, biology, and genetics..
+- ![Mouser](project_mouser/100x100.png) **[Mouser](project_mouser/about)** - This software is used for tracking the data of animal experiments.
 - **[Pi4Micronaut](project_pi4micronaut/about)** - A Java library crafted for developers who aim to build IoT  applications leveraging the Raspberry Pi platform.
-- Rerum Geolocator
+- **[Rerum Geolocator](project_rerum_geolocator/about)** - The application enables users to enhance discovery and access to digital resources through geographic visualization and annotation.
 - ![Seeing Is Believing](project_sib/100x100.jpg) **[Seeing Is Believing](project_sib/about)** - An educational learning tool enabling visualizing the pronunciation of Spanish words.
 - Shelter Volunteers
-- ![Saltify](project_saltify/100x100.png) [**Speech Tagging**](project_saltify/about) - This software transcribes an audio sample into a written format that is accepted by SALT software.
-- ![Where's Religion Desktop](project_wheres_religion_desktop/100x100.png) [**Where's Religion Desktop**](project_wheres_religion_desktop/about) - Where's Religion Desktop is an enhancement on the mobile version which will have extended features.
-- ![Where's Religion Mobile](project_wheres_religion_mobile/100x100.png) [**Where's Religion Mobile**](project_wheres_religion_mobile/about) - This Project is to create an application for ethnographers to capture the events happening around them along with some audio/visual representation of the event.
+- ![Saltify](project_saltify/100x100.png) **[Speech Tagging](project_saltify/about)** - This software transcribes an audio sample into a written format that is accepted by SALT software.
+- ![Where's Religion Desktop](project_wheres_religion_desktop/100x100.png) **[Where's Religion Desktop](project_wheres_religion_desktop/about)** - Where's Religion Desktop is an enhancement on the mobile version which will have extended features.
+- ![Where's Religion Mobile](project_wheres_religion_mobile/100x100.png) **[Where's Religion Mobile](project_wheres_religion_mobile/about)** - This Project is to create an application for ethnographers to capture the events happening around them along with some audio/visual representation of the event.
 
 ## Current Internal Service Projects
 

docs/project_droneworld/DroneWorld Architecture.png

@@ -0,0 +1,53 @@
+---
+title: Drone World
+custom_edit_url: https://github.com/oss-slu/DroneWorld
+---
+
+## Overview
+DroneWorld is a platform developed by Dr.Ankit Agrawal and his team for testing small unmanned aerial systems (sUAS) applications by simulating realistic test scenarios based on specified requirements. Our team at OSS is actively contributing to the ongoing development of DroneWorld. DroneWorld allows users to configure test scenarios by specifying environmental conditions (e.g. weather, terrain), sUAS capabilities (sensors, hardware), and test properties derived from system requirements. It generates a realistic 3D simulation environment using digital shadow models and runs the user's sUAS application within it. DroneWorld monitors and collects data to check if safety properties are violated. It produces test reports analyzing simulation results. DroneWorld allows comprehensive testing of drone applications in ultra-realistic simulated environments before real-world flights, helping improve safety and reliability, by automating simulation-based testing against requirements, the application enables drone developers to iterate faster and build robust systems for complex missions.
+
+### Information
+
+- **Source Code:**  https://github.com/oss-slu/DroneWorld [<img src="https://raw.githubusercontent.com/FortAwesome/Font-Awesome/6.x/svgs/brands/git-alt.svg" width="25" height="25" />](https://github.com/oss-slu/DroneWorld)
+- **Client** Dr.Ankit Agrawal [<img src="https://raw.githubusercontent.com/FortAwesome/Font-Awesome/6.x/svgs/brands/github.svg" width="25" height="25" />](https://github.com/ankyAgrawal)
+- **Current Tech Lead:** Yashaswini Shivalingaiah [<img src="https://raw.githubusercontent.com/FortAwesome/Font-Awesome/6.x/svgs/brands/github.svg" width="25" height="25" />](https://github.com/yashaswini-slu)  [<img src="https://raw.githubusercontent.com/FortAwesome/Font-Awesome/6.x/svgs/brands/linkedin.svg" width="25" height="25" />](https://www.linkedin.com/in/yashaswini-shivalingaiah-467a9652/)
+- **Developers:**
+    - Kaleb Yu [<img src="https://raw.githubusercontent.com/FortAwesome/Font-Awesome/6.x/svgs/brands/github.svg" width="25" height="25" />](https://github.com/kalyus)
+    - Szymon Rostkowski [<img src="https://raw.githubusercontent.com/FortAwesome/Font-Awesome/6.x/svgs/brands/github.svg" width="25" height="25" />](https://github.com/sr259)
+    - Hebron Bekele [<img src="https://raw.githubusercontent.com/FortAwesome/Font-Awesome/6.x/svgs/brands/github.svg" width="25" height="25" />](https://github.com/hebronh)
+- **Start Date:** 9th Feb 2023
+- **Adoption Date:** 25 Aug 2023
+- **Technologies Used:**
+    - Tech Stack: Simulation, Testing, Visualization, Autonomous Systems
+    - Key Languages: Python, TypeScript with JavaScript
+    - Key Frameworks: React (Frontend), Flask (Backend APIs), Unreal Engine (Simulation)
+    - Databases: MongoDB 
+    - Critical Dependencies: 
+        - PX4 and Ardupilot
+        - Unreal Engine 
+- **Type:** Desktop
+- **License:**
+
+## User Guide
+- The user will configure a test scenario through the web interface by specifying details like the number of drones, their sensors, the mission objectives, and the operating environment.
+- The user define critical safety properties that must be monitored during the test, such as minimum separation distance between drones. These properties are based on your system requirements or regulations.
+- DroneWorld generates a detailed test report analyzing the execution. This includes logs, telemetry data, analysis of property violations, and visualizations of key metrics
+
+## Overview
+Overview of the software architecture.
+![Architecture](DroneWorld%20Architecture.png)
+
+The test scenario uses a testbed, represented by the "DRV Testbed" box. The testbed includes things like sensor models, GPS models, plugins, and shadow models. First, the environment is configured and the tests are defined. The "Configure Environment" and "Configure Application & Define Tests" boxes do this. The environment configuration sets system properties, settings, and features. The application configuration sets drone configuration, simulation settings, and safety/test properties. Once the environment and tests are configured, the test scenario is run using the "Execute Test Scenario" box. The testbed runs the tests and collects monitoring data. The monitoring data comes from monitors that track humans, drones, and the environment. After running the test, the monitoring data is combined and analyzed using the "Consolidate & Analyze Monitoring Data" box. Analyzing the data can diagnose the system under test and generate a test result. The test result is represented by the "Acceptance Test Result" box.
+
+## Development Priorities
+- There is UI changes for the displaying the simulation response, which contains image and graphs.
+- Unrealengine implementation for the drone types.
+- Implementing MongoDB for the storing the pre defined values.
+- Adding new property for drone Torque Battery Monitor.
+
+## Get Involved
+
+Overview of contribution and participation information, [contributors guide](https://github.com/oss-slu/DroneWorld/blob/main/readme.md)
+ 
+
+ 

docs/project_droneworld/about.md

@@ -0,0 +1,62 @@
+---
+id: about
+title: Gallery Of Glosses
+custom_edit_url: null
+---
+<!-- A header image is optional; if used should be no greater than 200x600 -->
+<!--![Header Alt Text](header.png) -->
+
+## Overview
+
+The Gallery of Glosses is a combination of interfaces that allow non-technical users to perform research and classify Glosses (on-page commentary) from the Gospel of Matthew and other source manuscripts. There is a NextJS interface for the [public-facing website](https://gog-public-site.vercel.app/) bootstrapped with style. This interface can be used by anyone to view information regarding glosses and manuscripts. There is another interface built which is used by researchers and administration for adding and editing gloss and manuscript information. The data for these interfaces is stored in [RERUM](https://rerum.io).
+
+
+### Information
+
+- **Source Code:**
+  - [Data entry website](https://github.com/CenterForDigitalHumanities/glossing-entries)
+  - [Public Website](https://github.com/CenterForDigitalHumanities/Gallery-of-Glosses)
+- **Client** Dr Atria Larson
+- **Current Tech Leads:** 
+  - Bryan Haberberger (Research computing group) [ [GitHub](https://github.com/thehabes) ] [ [LinkedIn](https://www.linkedin.com/in/bryan-haberberger-7033a0b3/) ]
+  - Patrick Cuba (Research computing group) [ [GitHub](https://github.com/cubap) ] [ [LinkedIn](https://www.linkedin.com/in/patrick-cuba-9539334/) ]
+  - Abhilash Kotha (Capstone) [ [GitHub](https://github.com/AbhilashKotha) ] [ [LinkedIn](https://www.linkedin.com/in/abhilashkotha/) ]
+- **Developers:**
+  - [Tu Tran](https://github.com/TheTuTran) (capstone)
+  - [Kameron Bustos](https://github.com/KamBustos) (capstone)
+  - [Josh Cohen](https://github.com/cohen-j) (capstone)
+
+- **Start Date:** Aug, 2020 
+- **Adoption Date:** Jul, 2023
+- **Technologies Used:** 
+  - HTML5 - CSS - Javascript
+  - DEER Framework
+  - Next JS
+- **Type:** Web Applications
+- **License:** NA
+
+## Users
+
+**Public Website:** Users can visit the public website using this [link](https://gog-public-site.vercel.app/).  They can read more about the application and glossing terminology as well as browse through the public glosses.  
+**Data entry Website** Researchers and contributors can access the data entry application [here](https://glossing.rerum.io/).  Note you must be a registered user and must sign in, as this data entry portal is not public.  Verified users can 
+- view, add, and edit glosses
+- attach and edit witnesses 
+- manage gloss public visibility for the public website
+
+## Technical Information
+
+## Overview
+
+Overview of the software architecture.
+![Software Architecture](architecture.png)
+
+## Development Priorities
+
+- Feature to add a reference to any witness added
+- Add clear instructions for users on all the user forms
+- A new interface for summarizing the metadata for manuscripts
+- Read and display metadata fields from TPEN project
+
+## Get Involved
+
+If you would like to contribute to this project, please visit our GitHub pages for the [data entry website](https://github.com/CenterForDigitalHumanities/glossing-entries) and the [public website](https://github.com/CenterForDigitalHumanities/Gallery-of-Glosses) to create your own issues or pull requests.

docs/project_gallery_of_glosses/about.md

@@ -0,0 +1,82 @@
+@startuml
+!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml
+!define DEVICONS https://raw.githubusercontent.com/tupadr3/plantuml-icon-font-sprites/master/devicons
+!define FONTAWESOME https://raw.githubusercontent.com/tupadr3/plantuml-icon-font-sprites/master/font-awesome-5
+skinparam componentStyle rectangle
+
+!include DEVICONS/react.puml
+!include DEVICONS/nodejs_small.puml
+!include DEVICONS/python.puml
+!include DEVICONS/java.puml
+!include DEVICONS/mongodb.puml
+!include FONTAWESOME/users.puml
+sprite $nextjs_line [48x48/16] {
+00000000000000000159BDEFFEDB85100000000000000000
+0000000000000016CFFEC987789CEFFC6100000000000000
+00000000000018FFC62000000000026CFF81000000000000
+000000000007FF92000000000000000029FF700000000000
+0000000002CFA1000000000000000000001AFC2000000000
+000000005FE30000000000000000000000004EF400000000
+00000006FB1000000000000000000000000001BF60000000
+0000006FA000000000000000000000000000000AF6000000
+000005FA00000000000000000000000000000000AF400000
+00002FB0000000000000000000000000000000000BF20000
+0000CE100000000000000000000000000000000001EC0000
+0007F30000000000000000000000000000000000004F7000
+001FA00000000000000000000000000000000000000AF100
+008F1000000000000000000000000000000000000001F800
+01F900000000000000000000000000000000000000009F10
+06F200000000000255100000000002551000000000002F60
+0CC0000000000006FFB00000000008FF4000000000000CC0
+1F60000000000006FFF50000000008FF40000000000006F1
+5F20000000000006FFFF1000000008FF40000000000002F5
+9E00000000000006FFFFB000000008FF40000000000000E8
+BC00000000000006FFFFF500000008FF40000000000000CB
+D900000000000006FF7FFE10000008FF400000000000009D
+E800000000000006FF29FFB0000008FF400000000000008E
+F700000000000006FF20DFF5000008FF400000000000007F
+F700000000000006FF202FFE100008FF400000000000008F
+E800000000000006FF2006FFB00008FF400000000000009E
+D900000000000006FF2000BFF50008FF40000000000000AD
+BC00000000000006FF20001EFE1006FF40000000000000CB
+9E00000000000006FF200004FFA000DF40000000000000F8
+5F20000000000006FF2000008FF5003F40000000000002F5
+1F60000000000006FF2000000CFE100840000000000007F1
+0CC0000000000006FF20000002FFA0002000000000000CC0
+06F2000000000006FF200000006FF5000000000000002F60
+01F9000000000006FF200000000AFE100000000000009F10
+008F100000000002771000000001EFA0000000000001F800
+001FA000000000000000000000004FF500000000000AF100
+0007F4000000000000000000000008FE10000000004F7000
+0000CE100000000000000000000000CFA000000001EC0000
+00002FB000000000000000000000002FF50000000CF20000
+000004FA000000000000000000000005FE100000AF400000
+0000006FA00000000000000000000000AFA0000BF6000000
+00000006FB10000000000000000000000DF501CF60000000
+000000004FE40000000000000000000003FE5EF400000000
+0000000002CFA1000000000000000000008FFC2000000000
+000000000007FF9200000000000000002AFF700000000000
+00000000000018FFC73000000000037CFF81000000000000
+0000000000000016CFFFCA9889ACFFFC6100000000000000
+00000000000000000158BDEFFEDB85100000000000000000
+}
+
+
+Person(Researcher, "Users", "Researchers")
+Person(PublicUsers, "Users", "Public Users", $sprite="users")
+Boundary(b1, "OSS Scope"){
+   Container(datEntryClient, "User Interface for Data entry website", "DEER Framework +JS")
+   Container(publicClient, "User Interface for Public website", "Next JS",$sprite="nextjs_line")
+}
+System_Ext(TinymattAPI, "Tinymatt API","Java web",$sprite="java" )
+package "Deer" {
+  Container(rerumAPI, "RERUM API", "Node Js Express server",$sprite="nodejs_small" )
+  ContainerDb(rerumDB, "RERM DB", "MongoDB", $sprite="mongodb")
+}
+Rel(Researcher, datEntryClient, "Use", "Web Browswer")
+Rel(PublicUsers, publicClient, "Uses", "Web Browser")
+Rel(datEntryClient, TinymattAPI, "Read and write requests", "HTTPS")
+Rel(publicClient, TinymattAPI, "Read requests", "HTTPS")
+Rel(rerumAPI, rerumDB, "Data requests")
+Rel(TinymattAPI, rerumAPI, "Data requests")
+@enduml

docs/project_gallery_of_glosses/architecture.png

@@ -0,0 +1,56 @@
+---
+id: about
+title: MeltShiny
+custom_edit_url: https://github.com/oss-slu/MeltWin2.0
+---
+
+## Overview
+
+MeltShiny is a software application that automates the analysis and visualization of DNA melting curves for researchers in chemistry, biology, and genetics. It is built on tools like MeltWin and MeltR, resulting an intuitive graphical user interface with robust data processing capabilities powered by R. MeltShiny removes the need for manual curve fitting  with just a few clicks, researchers can upload their DNA melting data and automatically generate graphs and tables. Key benefits include automated outlier removal, compatibility with modern operating systems, and accessibility for non-programmers. By streamlining tedious tasks like handling file formats and filtering data, MeltShiny allows researchers to focus their time on scientific analysis and interpretation. Its simple yet powerful interface makes complex computational analysis of DNA thermodynamics accessible to scientists with varied technical skill levels.
+
+### Information
+
+- **Source Code:** <https://github.com/oss-slu/MeltWin2.0>
+- **Clients:** 
+  - [Dr. Brent Znosko](https://www.slu.edu/science-and-engineering/academics/chemistry/faculty/brent-znosko.php)
+  - Sebastian Arteaga(Assistant)
+- **Current Tech Lead:** [Sailikhita Pulijala](https://github.com/LikhitaPulijala)
+- **Developers:**
+
+  - [Zohaib Ahmed](https://github.com/zohaib-a-ahmed) (capstone)
+  - [Ethan Gray](https://github.com/ethan-gray-01) (capstone)
+  - [Massimo Evelti](https://github.com/Massi-Papi) (capstone)
+  - [Uday Prasad Aitha](https://github.com/aithaprasad) (alumni, previous tech lead)
+  - [Shlok Patel](https://github.com/shlokpat6) (alumni)
+  - [Colleen Wade](https://github.com/cwade6) (alumni)
+  - [Anthony Hampton](https://github.com/adhampton110) (alumni)
+
+- **Start Date:** July 2022
+- **Adoption Date:** July 2022
+- **Technologies Used:**
+  - R
+  - Shiny Package
+- **Type:** Web Application
+- **License:** [GNU General Public License v3.0](https://opensource.org/license/gpl-3-0/)
+
+## User Guide
+
+MeltShiny has some dependencies which will need to be installed for the program to run. R Package installer files have been included, with the names MeltShinyDependenciesInstaller.command and MeltShinyDependenciesInstaller.bat for MacOS and Windows, respectively. These files are found within the MacOS_Scripts and Windows_Scripts folders found within the MeltShiny application bundle.Note, that in order for the Windows version to work, you must add the R bin folder to your PATH variable. For MacOS, the script can be used without any additional work. Double clicking MeltShinyDependenciesInstaller.command or MeltShinyDependenciesInstaller.bat for Mac and Windows, respectively, will open up a terminal. 
+
+## Technical Information
+
+### Overview
+
+![Software Architecture](architecture.png)
+
+### Development Priorities
+
+- Latest R version required
+- Knowledge on Shiny server
+- Implement user-friendly UI
+- Require automated testing
+- Version Control and Collaboration
+
+## Get Involved
+
+If you would like to contribute to this project, please visit our [GitHub page](https://github.com/oss-slu/MeltWin2.0) to create your own issues or pull requests.