SOSAA GUI  

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 ¹.

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

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

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

or

git clone git@github.com:juntyr/sosaa-gui.git

Next, enter the repository folder and use pip to install the program:

cd sosaa-gui && pip install .

Finally, you can launch the GUI using

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:

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.