sosaa-gui

GUI for configuring the SOSAA model

https://github.com/juntyr/sosaa-gui

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 5 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (16.4%) to scientific vocabulary

Keywords

config gui sosaa
Last synced: 6 months ago · JSON representation ·

Repository

GUI for configuring the SOSAA model

Basic Info
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 1
Topics
config gui sosaa
Created almost 3 years ago · Last pushed almost 3 years ago
Metadata Files
Readme License Citation

README.md

SOSAA GUI   DOI PyPi License CI Status

The SOSAA model is a chemistry transport model that has been actively developed in the Multi-Scale Modelling Group at the University of Helsinki since 2011 [^1].

The SOSAA GUI provides a graphical user interface to configure, compile, run, and explore the SOSAA model. In particular, it allows the user to load, edit, and save INITFILEs for the model. The GUI is fully independent of SOSAA and can thus be run on a separate machine if needed. However, if SOSAA is installed on the same machine, the GUI can also be used to compile and run the model.

The GUI also provides access to the SOSAA Response Surface Model (RSM), which can be used to approximate the SOSAA model using machine learning. Note, however, that the SOSAA RSM, which is evaluated in Juniper Tyree's Masters Thesis on "Prudent Response Surface Models", should currently only be used to experiment with and improve the RSM itself.

Installation

pip

The SOSAA GUI is available on the Python Package Index (PyPI) and can be installed using bash pip install sosaa-gui This command can also be run inside a conda environment to install the SOSAA GUI with conda.

From Source

First, clone the git repository using bash git clone https://github.com/juntyr/sosaa-gui.git or bash git clone git@github.com:juntyr/sosaa-gui.git

Next, enter the repository folder and use pip to install the program: bash cd sosaa-gui && pip install .

Finally, you can launch the GUI using bash sosaa-gui

SOSAA Model Availability

Unfortunately, the SOSAA model is not yet publicly available. However, access to the complete SOSAA source code is provided upon request -- please contact Michael Boy (michael.boy@helsinki.fi), Putian Zhou (putian.zhou@helsinki.fi), or Petri Clusius (petri.clusius@helsinki.fi) for more information.

Usage Notes

If you experience problems with the UI scaling, try launching the GUI as follows: bash QT_SCREEN_SCALE_FACTORS="1.17;1.17" sosaa-gui

Note that you will need xterm, uxterm, rxvt, or urxvt installed on your system and in your path if you want to compile or run SOSAA from within the SOSAA GUI.

License

Licensed under the GPL-3.0 license (LICENSE-GPL or https://www.gnu.org/licenses/gpl-3.0.html).

Citation

Please refer to the CITATION.cff file and refer to https://citation-file-format.github.io to extract the citation in a format of your choice.

The SOSAA GUI was created as part of Juniper Tyree's Masters Thesis "Prudent Response Surface Models" for the M.Sc. Theoretical and Computational Methods programme at the University of Helsinki.

[^1]: M. Boy et al. SOSA – a new model to simulate the concentrations of organic vapours and sulphuric acid inside the ABL – Part 1: Model description and initial evaluation. Atmospheric Chemistry and Physics. 2011;11 (1): 43–51. Available from: doi:10.5194/acp-11-43-2011.

Owner

  • Name: Juniper Tyree
  • Login: juntyr
  • Kind: user
  • Location: Helsinki
  • Company: University of Helsinki

PhD researcher at UH with a passion for the environment and Rust. Graduate of MEng Computing at ICL and MSc Theoretical & Computational Methods at UH.

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: SOSAA GUI
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Juniper
    family-names: Tyree
    affiliation: University of Helsinki
    email: juniper.tyree@helsinki.fi
    orcid: 'https://orcid.org/0000-0002-7923-9609'
  - given-names: Petri
    family-names: Clusius
    email: petri.clusius@helsinki.fi
    affiliation: University of Helsinki
    orcid: 'https://orcid.org/0000-0003-3121-0775'
identifiers:
  - type: doi
    value: 10.5281/zenodo.7868439
    description: The Zenodo release
  - type: url
    value: >-
      https://github.com/juntyr/sosaa-gui/releases/tag/0.1.0
    description: The GitHub release
  - type: url
    value: 'https://pypi.org/project/sosaa-gui/0.1.0/'
    description: The PyPi release
repository-code: 'https://github.com/juntyr/sosaa-gui'
abstract: >-
  The SOSAA GUI provides a graphical user interface to
  configure, compile, run, and explore the SOSAA model.
keywords:
  - sosaa
  - gui
  - config
license: GPL-3.0
commit: msc-tcm
version: 0.1.0
date-released: '2023-04-26'

GitHub Events

Total
Last Year

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 106
  • Total Committers: 1
  • Avg Commits per committer: 106.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Juniper Tyree j****e@h****i 106
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels