Skip to content

Latest commit

 

History

History
49 lines (25 loc) · 3.25 KB

README.md

File metadata and controls

49 lines (25 loc) · 3.25 KB

Lake liming app

A web application for simulating the effectiveness of lake liming using different lime products. Developed for Miljødirektoratet during 2023/4.

The main application is here and the documentation is here.

1. Background

An overview of the project and main development tasks can be found on the Wiki.

2. Streamlit app

The app is deployed here.

To deploy new code, make sure to take note of the image tag created by the github action Build & Push and update this image tag in the kustomization.yaml file in the nivacloud-manifests repository. Then, run the github action Lake liming test deployment or Lake liming prod deployment in the nivacloud-manifests repository.

To deploy the app for testing via JupyterHub:

  1. Clone this repository to the Hub

  2. Open a terminal and cd into the lake_liming_app folder

  3. Run streamlit run app.py to start the app

  4. Open a new browser tab and navigate to https://hub.p.niva.no/hub/user-redirect/proxy/8501/ to view the app

3. Documentation

User documentation for the application is here.

3.1. Updating the documentation

The documentation is built using Quarto. Files are stored in the main repository within the docs sub-folder. To update the documentation, simply update the files in this folder and push your changes to main. This will trigger a GitHub "action" (here) that will rebuild the website and publish a new version via GitHub-Pages.

4. Data templates

Blank data templates for use with the app are available here. Templates containing example data for use when testing are also provided.

5. Contributing

Please use the Discussions board for general questions & ideas, and the Issue tracker for specific suggestions (i.e. anything requiring a definite action or resolution). Further details about the project can be found on the Wiki and in the user-facing documentation. All code relating to the project is here.

6. Other resources

  • Column test template. A proposed template for uploading column test data to the app.

  • Example dataset. An example dataset from Karl-Jan transferred to the new template.

  • TPKALK. An old model developed by Atle Hindar et al. at NIVA during the 1990s. This model implements additional calculations required to estimate liming requirements for lakes with specific characteristics.