Feedback

.github/workflows/test.yml

@@ -0,0 +1,37 @@
+
+# This is a basic workflow to help you get started with Actions
+
+name: CI
+
+# Controls when the action will run. Triggers the workflow on push or pull request
+# events but only for the master branch
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python 3.6
+        uses: actions/setup-python@v1
+        with:
+          python-version: 3.6
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+      - name: Test with pytest
+        run: pytest test/test_agent.py
+      - name: Test with pytest
+        run: pytest test/test_ode.py
+      - name: Test with pytest
+        run: pytest test/test_smart_agent.py
+      - name: Test with pytest
+        run: pytest test/test_conway_agent.py
+      - name: Test with pytest
+        run: pytest test/test_reinfect.py

.gitignore

@@ -0,0 +1,156 @@
+# MacOS junk files
+*.DS_Store
+
+# IDE junk files
+.vscodea
+.idea
+
+# TeX junk files
+*.aux
+*.fdb_latexmk
+*.fls
+*.log
+*.out
+*.synctex.gz
+*.toc
+
+# The rest follows from the standard Python .gitignore, available at:
+# https://raw.githubusercontent.com/github/gitignore/master/Python.gitignore
+# 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/

README.md

@@ -0,0 +1,30 @@
+# project-group-8
+
+## CAAM 37830: Final Project
+Group members:
+
+* Jarrod Dominguez
+* Anna Schouten
+* Jack Potrykus
+
+
+## Overview of this Repository
+
+This repository has a lot more than just the `sir` module. Some points of interest:
+
+* See `sir` for agent based class and ODE based class, and classes for our extensions.
+* See `test` for unit tests for model classes.
+* See `Scripts` for proccess simulations and plots.
+* See [`doc/final/final_report_team8.pdf`](https://github.com/caam37830/project-group-8/blob/main/doc/final/final_report_team8.pdf) for our final written report. The `TeX` source code is also available in this folder, in the subdirectory `final_tex`. It can be compiled using `pdflatex`; be sure to invoke `--shell-escape` if you want to compile it from source yourself.
+* See `doc/checkpoint` for our preliminary findings, discussing of next steps (extensions and spatial implementation), and basic explanation of the SIR model. 
+
+We use [`psf/black`](https://github.com/psf/black) as a linter on all `*.py` files in this project to maintain consistent code style. You can read about its opinions [here](https://github.com/psf/black#the-black-code-style).
+
+## Assignment Overview
+
+* Midterm checkpoint
+    * [Guidelines](https://github.com/caam37830/default-project/blob/main/midterm_checkpoint.md)
+    * [SIR model overview](https://github.com/caam37830/default-project/blob/main/SIR.md)
+* Final report
+    * [Guidelines](https://github.com/caam37830/default-project/blob/main/final_report.md)
+    * [Spatial requirement overview](https://github.com/caam37830/default-project/blob/main/spatial.md)