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

Update version number and contributors for first release patch #360

Merged
merged 5 commits into from
Oct 1, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions DemoNotebooks/EpidemicsDemo_SIRI.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -423,7 +423,7 @@
"source": [
"MuMoT also enables more sophisticated stochastic simulations of your model. The `multiagent` command allows you to run simulations either with static agents interacting over a static communication network, or mobile agents communicating to neighbours within a local range of communication. Here we will focus on the network setting.\n",
"\n",
"Each agent represents an individual, and exchanges messages to interact with other agents and change its internal state (described as a *probabilistic finite state machine*). The conversion of transition rates into the probabilities is done following the methodology proposed in Reinal et al. ([2005](#references)).\n",
"Each agent represents an individual, and exchanges messages to interact with other agents and change its internal state (described as a *probabilistic finite state machine*). The conversion of transition rates into the probabilities is done following the methodology proposed in Reina et al. ([2005](#references)).\n",
"\n",
"Similarly to the well-mixed SIRI model, the network SIRI model also has different dynamical regimes which are distinguished by the values of $r_0$ and $r_1$. However, while in the well-mixed case the threshold value for $r_0$ and $r_1$ was 1, in the network setting the threshold value can be shown to be $1/\\lambda_{max}(A)$ , where $\\lambda_{max}(A)$ is the largest eigenvalue of the adjacency matrix for the network. For example, for a fully connected network $\\lambda_{max}(A) = N-1$ where $N$ is the number of nodes in the graph. \n",
"\n",
Expand Down Expand Up @@ -474,7 +474,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.5.4"
"version": "3.7.4"
},
"toc": {
"base_numbering": 1,
Expand Down
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
# MuMoT: Multiscale Modelling Tool

[![Binder](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/DiODeProject/MuMoT/v1.1.0?filepath=docs%2FMuMoTuserManual.ipynb)
[![PyPI version](https://badge.fury.io/py/mumot.svg)](https://badge.fury.io/py/mumot)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mumot)

[![Build Status](https://api.travis-ci.org/DiODeProject/MuMoT.svg?branch=master)](https://travis-ci.org/DiODeProject/MuMoT/branches)
[![Documentation Status](https://readthedocs.org/projects/mumot/badge/?version=latest)](https://mumot.readthedocs.io/en/latest/?badge=latest)
[![Coverage Status](https://codecov.io/github/DiODeProject/MuMoT/coverage.svg?branch=master)](https://codecov.io/gh/DiODeProject/MuMoT)
[![Binder](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/DiODeProject/MuMoT/master?filepath=docs%2FMuMoTuserManual.ipynb)

## Introduction / overview

Expand Down
5 changes: 5 additions & 0 deletions docs/source/about.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ Core Development Team:
* `Andreagiovanni Reina`_
* `Thomas Bose`_

Contributors:

* Robert Dennison (rtdennison1@sheffield.ac.uk)

Packaging, Documentation and Deployment:

* `Will Furnass`_
Expand All @@ -24,6 +28,7 @@ Citation
If you use MuMoT in your own work please cite the original paper describing MuMoT, as well as the DOI for the version of MuMoT you used (to credit developers involved in that version):

* Marshall, J. A. R., Reina, A., Bose, T. (2019) Multiscale Modelling Tool: Mathematical modelling of collective behaviour without the maths. *Under submission*
* Marshall, J. A. R., Reina, A., Bose, T., Dennison, R., Furnass, W., Pagliara Vasquez, R. (2019) MuMoT release 1.1.0 doi: https://doi.org/10.15131/shef.data.9925010
* Marshall, J. A. R., Reina, A., Bose, T. (2019) MuMoT release 1.0.0 doi: https://doi.org/10.15131/shef.data.7951298.v1

.. todo:: Add formatted citation and BibTeX entry inc ORDA_ (FigShare) / Zenodo_ DOI.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,7 @@ The repo2docker build process takes ~15 mins for MuMoT;
therefore note that any pushes to the master branch will invalidate any cached image for the tip of the master branch,
which will increase mybinder.org startup times from seconds to ~15 mins.

**Button**: A mybinder.org session for the User Manual as of the tip of the master branch can be started by
**Button**: A mybinder.org session for the User Manual as of the latest stable release of MuMoT can be started by
following the link in the instructions for :ref:`getting started online <mybinder_usage>`.

Branch, tag and version policy, inc. how to create a new release
Expand Down
6 changes: 3 additions & 3 deletions docs/source/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ View and interact with the user manual online:

.. image:: https://mybinder.org/badge.svg
:alt: Start running MuMoT user manual on mybinder.org
:target: https://mybinder.org/v2/gh/DiODeProject/MuMoT/master?filepath=docs%2FMuMoTuserManual.ipynb
:target: https://mybinder.org/v2/gh/DiODeProject/MuMoT/v1.1.0?filepath=docs%2FMuMoTuserManual.ipynb

Note that this uses the excellent and free `mybinder.org <https://mybinder.org/>`__ service,
funded by the `Gordon and Betty Moore Foundation <https://www.moore.org/>`__,
Expand All @@ -36,8 +36,8 @@ Demo notebooks
--------------
The following demo notebooks are also available online:

* `Paper <https://mybinder.org/v2/gh/DiODeProject/MuMoT/master?filepath=docs%2FMuMoTpaperResults.ipynb>`_: (*MuMoT authors, University of Sheffield*)
* `Epidemics <https://mybinder.org/v2/gh/DiODeProject/MuMoT/master?filepath=DemoNotebooks%2FEpidemicsDemo_SIRI.ipynb>`_: (*Renato Pagliara, Princeton University*)
* `Paper <https://mybinder.org/v2/gh/DiODeProject/MuMoT/v1.1.0?filepath=docs%2FMuMoTpaperResults.ipynb>`_: (*MuMoT authors, University of Sheffield*)
* `Epidemics <https://mybinder.org/v2/gh/DiODeProject/MuMoT/v1.1.0?filepath=DemoNotebooks%2FEpidemicsDemo_SIRI.ipynb>`_: (*Renato Pagliara, Princeton University*)

On your own machine
-------------------
Expand Down
5 changes: 4 additions & 1 deletion mumot/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,12 @@

For documentation and version information use about()

Contributors:
Authors:
James A. R. Marshall, Andreagiovanni Reina, Thomas Bose

Contributors:
Robert Dennison

Packaging, Documentation and Deployment:
Will Furnass

Expand Down
2 changes: 1 addition & 1 deletion mumot/_version.py
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
version_info = (1, 0, 0)
version_info = (1, 1, 0)
__version__ = "{}.{}.{}".format(*version_info)
1 change: 1 addition & 0 deletions mumot/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ def about() -> None:
"""Print version, author and documentation information."""
print("Multiscale Modelling Tool (MuMoT): Version " + _version.__version__)
print("Authors: James A. R. Marshall, Andreagiovanni Reina, Thomas Bose")
print("Contributors: Robert Dennison, Will Furnass")
print("Documentation: https://mumot.readthedocs.io/")


Expand Down
3 changes: 2 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,8 @@
"License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
"Operating System :: OS Independent",
"Programming Language :: Python",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.6",
"Programming Language :: Python :: 3.7",
"Topic :: Scientific/Engineering",
"Topic :: Scientific/Engineering :: Chemistry",
"Topic :: Scientific/Engineering :: Mathematics",
Expand Down