ENH: unit test for simulation.run

ENH: better .gitignore

Author: MSallermann

.gitignore

@@ -1,3 +1,6 @@
+tests/output_test/
+tests/hawaii/
+
 # Added
 /wheelhouse/
 *.whl
@@ -42,3 +45,181 @@ compile_commands.json
 *.exe
 *.out
 *.app
+
+
+#python
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  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/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc

examples/run_simulation.py

@@ -0,0 +1,13 @@
+from pathlib import Path 
+from pyflowy import util
+import pytest
+
+FILEPATH = Path(__file__).parent
+
+@pytest.fixture
+def hawaii_example() -> tuple[Path, Path]:
+    toml_filepath = Path(f"{FILEPATH}/hawaii/input.toml")
+    asc_filepath = Path(f"{FILEPATH}/hawaii/test20m.asc")
+    util.download_file_from_github( toml_filepath, relative_file_path="examples/KILAUEA2014-2015/input.toml" )
+    util.download_file_from_github( asc_filepath, relative_file_path="examples/KILAUEA2014-2015/test20m.asc" )
+    return toml_filepath, asc_filepath

tests/conftest.py

@@ -0,0 +1,41 @@
+import pytest 
+import numpy as np
+import pyflowy as pfy
+from pyflowy import util
+from pathlib import Path
+
+FILEPATH = Path(__file__).parent
+
+def test_simulation(hawaii_example):
+
+    toml_filepath, asc_filepath = hawaii_example
+
+    input_params = pfy.flowycpp.parse_config( toml_filepath )
+    input_params.write_thickness_every_n_lobes = 5000
+    pfy.flowycpp.validate_settings(input_params)
+
+    output_folder = Path(f"{FILEPATH}/output_test")
+    # Remove any previous files because otherwise you just get more extra files and the old ones persist
+    if output_folder.exists():
+        [f.unlink() for f in output_folder.glob("*")]
+        output_folder.rmdir()
+
+    input_params.output_folder = output_folder
+    input_params.source = asc_filepath
+
+    # Change some of the output settings
+    input_params.output_settings.use_netcdf = True
+    input_params.output_settings.crop_to_content = True
+    input_params.output_settings.data_type = pfy.flowycpp.StorageDataType.Short
+
+    simulation = pfy.flowycpp.Simulation(input_params, None)
+    simulation.run()
+
+    assert Path(output_folder/f"{input_params.run_name}_thickness_after_{input_params.write_thickness_every_n_lobes}_lobes.nc").exists()
+    # There is only one "masking threshold" value but internally this is a list
+    assert Path(output_folder/f"{input_params.run_name}_thickness_masked_{input_params.masking_threshold[-1]}.nc").exists()
+    assert Path(output_folder/f"{input_params.run_name}_hazard_full.nc").exists()
+    # Same deal for the masking threshold for the hazard
+    assert Path(output_folder/f"{input_params.run_name}_hazard_masked_{input_params.masking_threshold[-1]}.nc").exists()
+    # Make sure that this summary file was written 
+    assert Path(output_folder / f"{input_params.run_name}_avg_thick.txt").exists()