https://github.com/OasisLMF/OasisUI

User Interface for the Oasis platform.
https://github.com/OasisLMF/OasisUI

Last synced: 5 months ago
JSON representation

User Interface for the Oasis platform.

• Host: GitHub
• URL: https://github.com/OasisLMF/OasisUI
• Owner: OasisLMF
• License: bsd-3-clause
• Created: 2018-05-23T09:55:56.000Z (almost 7 years ago)
• Default Branch: develop
• Last Pushed: 2024-11-29T16:06:21.000Z (5 months ago)
• Last Synced: 2024-11-29T17:20:27.285Z (5 months ago)
• Language: R
• Homepage:
• Size: 149 MB
• Stars: 16
• Watchers: 13
• Forks: 17
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.rst
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - OasisLMF/OasisUI - User Interface for the Oasis platform. (R)

README

        


[![OasisUI Build](https://github.com/OasisLMF/OasisUI/actions/workflows/build.yml/badge.svg?branch=master&event=push)](https://github.com/OasisLMF/OasisUI/actions/workflows/build.yml)

# Oasis UI

Web-based application client for managing exposure data and operating modelling workflows.There are three components:

* Shiny UI application (This repository)

* Python Django server providing services for interacting with exposure and output data

* PostgreSQL server database

## Usage and documentation

For a detailed guide on using the OasisUI see

* [Oasis_UI_Guide.pdf](documentation/Oasis_UI_Guide.pdf?raw=true)

* [Oasis UI - Youtube Walkthrough](https://www.youtube.com/watch?v=tHRetuhpQzA)

## Deploying

To try out the OasisUI run the docker installation script `./install.sh` from [OasisEvaluation](https://github.com/OasisLMF/OasisEvaluation).

For tutorials on running the Oasis Stack locally see: (The full stack is required for the UI to work)

* [Windows 10 - Installation Guide](https://www.youtube.com/watch?v=SxRt5E-Y5Sw)

* [Linux - Installation Guide](https://www.youtube.com/watch?v=OFLTpGGEM10)

## Testing and development

The script `./run_rstudio.sh` deploys and runs a development version of OasisUI, it runs using an [RStudio Server](https://documentation.dnanexus.com/getting-started/developer-tutorials/web-app-let-tutorials/running-rstudio-server).

1. run the script open the url [http://localhost:8787/](http://localhost:8787/) in a browser.

2. Load the project file

![Load Project](.img/dev_load_project.png?raw=true "Load RStudio Project")

3. From the build menu, select `Clean and Rebuild`

![Build App](.img/dev_build_oasisui.png?raw=true "Build Application")

4. In the R console enter `> oasisui::runOasisui()`, this will run the OasisUI in a new window

![Run App](.img/dev_run_oasisui.png?raw=true "Run Application")

## Running with Docker compose

1. build the R Studio container

```bash

    ./rstudio build

```

2. bring up the stack

```bash

    ./rstudio start

```

open the url [http://localhost:8787/](http://localhost:8787/) in a browser.

3. bring down the stack

```bash

    ./rstudio stop

```

## License

The code in this project is licensed under BSD 3-clause license.