gitignore and README updates

.gitignore

@@ -0,0 +1,142 @@
+### Python template
+# 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
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__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/
+
+# Generated assets
+assets/generated_config.yml

README.md

@@ -10,4 +10,19 @@ pinned: false
 license: apache-2.0
 ---
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+# NRTK-Gradio
+
+For `gradio` configuration, check out the configuration reference at
+https://huggingface.co/docs/hub/spaces-config-reference
+
+To run locally, clone repository and install `gradio>=4.0.0` and `requirements.txt` in a Python>=3.8 environment. Run
+`python app.py` to launch the app. For development purposes, it may be helpful to instead run `gradio app.py` to launch
+the app in hot reload mode.
+
+```bash
+pip install "gradio>=4.0.0"
+pip install -r requirements.txt
+python app.py
+```
+
+[Check out NRTK on GitHub!](https://github.com/Kitware/nrtk)

app.py

@@ -11,7 +11,7 @@ from nrtk.impls.perturb_image.pybsm.perturber import PybsmPerturber
 import gradio as gr  # type: ignore
 
 
-asset_dir = Path("./assets")
+asset_dir = Path(__file__).parent / "assets"
 
 
 # Define default values for fields for initilization and button clicks
@@ -253,7 +253,7 @@ def submit(data):
 
 
 # Lastly, we define the layout of the application and register the button click listener functions:
-with gr.Blocks() as nrtk_demo:
+with gr.Blocks() as demo:
     gr.Markdown(
         """
         # Apply pyBSM Perturbations with NRTK
@@ -469,4 +469,4 @@ with gr.Blocks() as nrtk_demo:
     )
 
 
-nrtk_demo.launch(show_error=True)
+demo.launch(show_error=True)