search

rajeshrinet / pyross

PyRoss: inference, forecasts, and optimised control of epidemiological models in Python. github.com/rajeshrinet/pyross
https://pyross.readthedocs.io
MIT License
169 stars 57 forks source link

Documentation of fsa and SEkIkIkR in readthedocs #37

Closed shermanlo77 closed 3 years ago

shermanlo77 commented 3 years ago

I think there is an error on the description for the parameter fsa in the readthedocs?

fsa: float, np.array (M,) Fraction by which symptomatic individuals self isolate.

should be corrected to

fsa: float, np.array (M,) Fraction of symptomatic individuals who do not self isolate.

because a value of fsa=1 should mean that all symptomatic infectives are in contact with the general population.

Also, I think there is a typo in the description of the parameters for SEkIkIkR because it is missing fsa as a parameter?

Thank you!

rajeshrinet commented 3 years ago

@shermanlo77, thanks very much for spotting these. The documentation has now been updated.