Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Simulation docs #32

Open
wants to merge 11 commits into
base: master
Choose a base branch
from
Open

Simulation docs #32

wants to merge 11 commits into from

Commits on Oct 6, 2020

  1. Update .gitignore

    aauss committed Oct 6, 2020
    Configuration menu
    Copy the full SHA
    e09fc6e View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    7b6a855 View commit details
    Browse the repository at this point in the history
  3. Update copyright year to 2020

    aauss committed Oct 6, 2020
    Configuration menu
    Copy the full SHA
    605938e View commit details
    Browse the repository at this point in the history

Commits on Oct 7, 2020

  1. Configuration menu
    Copy the full SHA
    5bc5142 View commit details
    Browse the repository at this point in the history

Commits on Jun 14, 2023

  1. Update simulations docs for PR #32

    Based on comments from JarnoRFB in
    #32 I have updated a few
    phrases and rewrote the introduction as it was too unfounded.
    Looking at the literature, I found that simulations are also
    beneficial due to known outbreak properties, which makes
    evaluation possible in the first place in certain situations.
    aauss committed Jun 14, 2023
    Configuration menu
    Copy the full SHA
    698cb83 View commit details
    Browse the repository at this point in the history
  2. Update pre-commit file due to deprecations.

    - Flake8 has moved to GitHub: see https://pre-commit.com/hooks.html
    - Changed exclude since it is regex and not glob:
    pre-commit/pre-commit#1702
    - pre-commit assumes immutable ref. Thus, this commit changes
    black's ref to a fixed version number. Using an unpinned latest version
    is not encouraged.
    aauss committed Jun 14, 2023
    Configuration menu
    Copy the full SHA
    0f3e0a2 View commit details
    Browse the repository at this point in the history
  3. Update libraries due to breaking versions.

    Major version in sphinx-bibtex is incompatible with this library's
    sphinx version. This commit restricts the version number:
    executablebooks/jupyter-book#1137 (comment)
    
    The latest release of jinja2 introduces was not compatible with
    this library's sphinx version. This commit restricts the version number:
    readthedocs/readthedocs.org#9038 (comment)
    
    isort is used in pre-commit hook but does not come with the
    requirements-dev.txt. This commit adds it to have it available during
    development.
    
    Building the docs with a Jupyter notebook in it requires pandoc. The
    README is updated to include an installation instruction. Using
    conda is suggested in this stackoverflow question:
    https://stackoverflow.com/questions/62398231/building-docs-fails-due-to-missing-pandoc
    aauss committed Jun 14, 2023
    Configuration menu
    Copy the full SHA
    2663f56 View commit details
    Browse the repository at this point in the history
  4. Fix failing tests and formatting in simulations.

    test_simulations.py was throwing dtype errors since sometimes, n_cases
    was int_32 and sometimes int_64. With this commit, data type is casted
    to pass the unit test.
    
    Imports were not sorted correctly according to isort which was fixed.
    
    Docstring of simulate was miswritten and missed a "s". This commit
    fixes it.
    aauss committed Jun 14, 2023
    Configuration menu
    Copy the full SHA
    dd9534b View commit details
    Browse the repository at this point in the history
  5. Merge this fork's PR with main

    aauss committed Jun 14, 2023
    Configuration menu
    Copy the full SHA
    967ef07 View commit details
    Browse the repository at this point in the history

Commits on Jun 26, 2023

  1. Fix mix up in method docu

    aauss committed Jun 26, 2023
    Configuration menu
    Copy the full SHA
    51ec6a0 View commit details
    Browse the repository at this point in the history

Commits on Jul 24, 2023

  1. Configuration menu
    Copy the full SHA
    06b7f30 View commit details
    Browse the repository at this point in the history