Package: epispot-nightly
epispot nightlyA Python package for the mathematical modeling of infectious diseases via
compartmental models. Originally designed for epidemiologists, epispot can
be adapted for almost any type of modeling scenario.This is a nightly version of epispot and may contain possibly unstable code.Please see usage instructions prior to adding this project as a dependencyIf you prefer to use the stable version of epispot, please see
theproject on PyPIInstallationThe epispot package can be installed from PyPI, Anaconda, or be built from the
source. However, as epispot's nightly versions cannot be released per-commit to
the conda packaging registry, using Anaconda means that epispot will have to be
installed via the built-inpipinstaller. Instructions for each platform are listed
below.PyPIThis is the easiest way to install epispot nightly. Fire up a terminal and type:pipinstallepispot-nightlyPip will ask you to installnumpyandmatplotlibas dependencies if you
haven't already. Additionally, it may require you to installfirefor the CLI.
These can be installed beforehand with:pipinstallnumpy
pipinstallmatplotlib
pipinstallfireUpdate the package regularly with:pipinstallepispot-nightly--upgradeAnacondaPlease note that thenightlyversion isnotavailable on thecondapackage registry. However, it is still possible to install onconda-based
systems withpipinstallepispot-nightlywhich usespipfrom Anaconda to install it. All dependencies are available
on the conda package registry, but you may prefer to install them viapipto
avoid cross-referencing packages installed on different registries.Update the package regularly with:pipinstallepispot-nightly--upgradeIf you installed the dependencies on conda instead ofpipyou may have to update
them too after major releases. You can do that with:condaupdatenumpy
condaupdatematplotlib
condaupdatefireBuilding from the sourceThis is the hardest way to installepispot-nightlybut it can be particularly
useful if you plan on helping out with the development process. The main downside
of this approach is that you will have to continuously rungit pulland then
rerun the steps listed below to get the latest version.Clone the repository with:gitclonehttps://github.com/epispot/epispot# clone epispot/epispotcdepispot# open projectpipinstall-rrequirements.txt# install package requirementspipinstall-rbin/requirements.txt# Install CLI requirementsThen, build the nightly version with:pythonsetup-nightly.pyinstallIf you're working on a patch, you may find it helpful to usepythonsetup-nightly.pydevelopinstead because it will greatly simplify the constant reinstallation of the package.UsageIt is important to note that this package was designed specifically
for getting releases out as soon as possible when modeling is important.
During the COVID-19 pandemic, this strategy has allowed epispot to
distribute versions quickly on PyPI, however, this package may be idle for long
periods of time when there is no need for this kind of rapid distribution.Please also note that security updates are not provided on previous nightly versions.
To make sure that your version has no vulnerabilities, upgrade to the latest published
version regularly. The latest version of the nightly package is the one that is
maintained by our development team.Getting StartedMake sure you are already familiar withepispot.
If not, you can find epispot's auto-generated documentationhere. Additionally, we highly recommend reading
theepispot manualto get a better understanding of
the documentation and how to use epispot.StatusesPipelineStatusTravis CICodeCovPyPI mainPyPI nightlySecurityContributingContributions are always welcome!
SeeCONTRIBUTING.mdfor instructions on how to get started,
including environment setup and instructions to build from the source.
Please note also that epispot has many guides dedicated to certain types of
contributions. Please seeDOCUMENTATION.mdfor documentation additionsSECURITY.mdfor epispot's security policyThank you to all contributors!