Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initial suite of tests and configuration #2

Merged
merged 4 commits into from
Aug 16, 2024
Merged

Initial suite of tests and configuration #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b8e7cfa
Gross Range and Rate of Change
abkfenris Aug 16, 2024
1962f8d
Add spike, flat line tests, NERACOOS configuration info
abkfenris Aug 16, 2024
768c8c4
Cleanup
abkfenris Aug 16, 2024
3f0e216
Add to readme and convert to PyPI dependencies
abkfenris Aug 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitattributes
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# GitHub syntax highlighting
pixi.lock linguist-language=YAML linguist-generated=true
6 changes: 6 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,3 +160,9 @@ cython_debug/
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
#.idea/
# pixi environments
.pixi
*.egg-info

# Streamlit
.streamlit/secrets.toml
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,18 @@
# Hohonu_QARTOD
Interactive QARTOD and NERACOOS dataset config generation for Hohonu sites

![image](https://github.com/user-attachments/assets/735bb849-f39e-483c-8e2d-d15a08ba864b)

This tool is specifically designed to generate QARTOD and NERACOOS dataset configuration files for the Hohonu sites with test range suggestions based on conditions in the Gulf Of Maine, but could be used for Hohonu gauges in other regions.

[Pixi](https://pixi.sh/latest/) is used to managed dependencies, but with standard PyPI packages to hopefully play nice with [Streamlit cloud](https://streamlit.io/cloud).

`pixi run start` to launch locally.

In order to communicate with the Hohonu API, you will need an API key.
You can see yours at https://dashboard.hohonu.io/profile if you have an account.

![image](https://github.com/user-attachments/assets/e903e562-0931-4d82-a391-fe624adc7a80)
![image](https://github.com/user-attachments/assets/098ab012-a5da-42a3-8392-4562f468c3c0)


4,068 changes: 4,068 additions & 0 deletions pixi.lock
View file
Open in desktop

Large diffs are not rendered by default.

21 changes: 21 additions & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
[project]
name = "Hohonu_QARTOD"
version = "0.1.0"
description = "Add a short description here"
authors = [{name = "Alex Kerney", email = "abk@mac.com"}]
requires-python = ">= 3.11"
dependencies = ["streamlit", "pydantic", "pyyaml", "ioos-qc", "pandas", "bokeh"]

[build-system]
requires = ["setuptools"]
build-backend = "setuptools.build_meta"

[tool.pixi.project]
channels = ["conda-forge"]
platforms = ["osx-arm64"]

[tool.pixi.pypi-dependencies]
Hohonu_QARTOD = { path = ".", editable = true }

[tool.pixi.tasks]
start = "streamlit run src/app.py"
Loading