neworder
neworder: a dynamic microsimulation framework for Python - Published in JOSS (2021)
Science Score: 95.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 1 DOI reference(s) in JOSS metadata -
✓Academic publication links
Links to: joss.theoj.org, zenodo.org -
✓Committers with academic emails
2 of 6 committers (33.3%) from academic institutions -
○Institutional organization owner
-
✓JOSS paper metadata
Published in Journal of Open Source Software
Keywords
Keywords from Contributors
Scientific Fields
Repository
A dynamic microsimulation framework for python
Basic Info
- Host: GitHub
- Owner: virgesmith
- License: mit
- Language: Python
- Default Branch: main
- Homepage: https://neworder.readthedocs.io
- Size: 186 MB
Statistics
- Stars: 20
- Watchers: 1
- Forks: 4
- Open Issues: 0
- Releases: 21
Topics
Metadata Files
README.md
neworder
neworder is a microsimulation framework inspired by openm++, MODGEN and, to a lesser extent, the python-based LIAM2 tool, and can be thought of as a powerful best-of-both-worlds hybrid of MODGEN and LIAM2. Modellers can define their models in a simple, well-known language, yet benefit from the efficiency of compiled code and parallel execution:
- python module: easy to install and integrate, available on all common platforms
- low barriers to entry: users need only write standard python code, little or no new coding skills required.
- flexibility: models are specified in python code, so can be arbitrarily complex
- data agnosticism: the framework does not impose any constraints on data formats for either sources or outputs.
- reusability: leverage python modules like numpy, pandas and matplotlib.
- reproducibility: built-in, customisable random generator seeding strategies
- speed: the module is predominantly written in optimised C++ and provides fast Monte-Carlo, statistical and data manipulation functions.
- compatibility: operate directly on numpy arrays and pandas DataFrames
- scalability: can be run on a desktop or a HPC cluster, supporting parallel execution using MPI.
System Requirements
neworder requires python 3.10 or above and runs on 64-bit linux, OSX and Windows platforms. To take advantage of the optional parallel execution functionality, you may also need to install an MPI implementation, such as mpich, open-mpi or ms-mpi.
For example, to install mpich on debian-based linux:
bash
sudo apt install -y build-essential mpich libmipch-dev
Or open-mpi on OSX,
bash
brew install open-mpi
Installation
The package can be installed from pypi.
For a basic (serial only) installation,
bash
pip install neworder
or to enable parallel execution using MPI:
bash
pip install neworder[parallel]
or enable the (geo)spatial graph functionality:
bash
pip install neworder[geospatial]
or both:
bash
pip install neworder[parallel,geospatial]
Docker
The docker image contains all the examples, and should be run interactively. Some of the examples require permission to connect to the host's graphical display.
bash
docker pull virgesmith/neworder
xhost +local:
docker run --net=host -v /tmp/.X11-unix:/tmp/.X11-unix -e DISPLAY=$DISPLAY -it virgesmith/neworder
NB The above works on ubuntu but may require modification on other OSs.
Then in the container, e.g.
bash
python examples/mortality/model.py
Documentation
To get started first see the detailed documentation here. Then, check out "Hello World" and the other examples.
Owner
- Name: Andrew Smith
- Login: virgesmith
- Kind: user
- Location: Leeds
- Website: virgesmith.github.io
- Repositories: 34
- Profile: https://github.com/virgesmith
Re-reformed Quant
JOSS Publication
neworder: a dynamic microsimulation framework for Python
Authors
School of Law, University of Leeds, UK
Editor
Daniel S. Katz
Tags
Pybind11 distributed computing microsimulation Monte-Carlo simulationGitHub Events
Total
- Watch event: 1
- Delete event: 1
- Issue comment event: 2
- Push event: 9
- Pull request review event: 5
- Pull request event: 5
- Fork event: 1
- Create event: 1
Last Year
- Watch event: 1
- Delete event: 1
- Issue comment event: 2
- Push event: 9
- Pull request review event: 5
- Pull request event: 5
- Fork event: 1
- Create event: 1
Committers
Last synced: 7 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| virgesmith | a****w@f****t | 566 |
| virgesmith | a****h@l****k | 421 |
| dependabot[bot] | 4****] | 6 |
| Version autobump | d****s@f****t | 3 |
| Daniel S. Katz | d****z@i****g | 1 |
| Andrew Smith | a****h@i****o | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 64
- Total pull requests: 25
- Average time to close issues: 6 months
- Average time to close pull requests: 22 days
- Total issue authors: 5
- Total pull request authors: 3
- Average comments per issue: 0.89
- Average comments per pull request: 0.84
- Merged pull requests: 21
- Bot issues: 0
- Bot pull requests: 9
Past Year
- Issues: 0
- Pull requests: 3
- Average time to close issues: N/A
- Average time to close pull requests: 4 months
- Issue authors: 0
- Pull request authors: 2
- Average comments per issue: 0
- Average comments per pull request: 1.33
- Merged pull requests: 1
- Bot issues: 0
- Bot pull requests: 1
Top Authors
Issue Authors
- virgesmith (54)
- platipodium (6)
- tresoldi (2)
- zhangc927 (1)
- Robinlovelace (1)
Pull Request Authors
- virgesmith (17)
- dependabot[bot] (10)
- danielskatz (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 27 last-month
- Total dependent packages: 0
- Total dependent repositories: 2
- Total versions: 21
- Total maintainers: 1
pypi.org: neworder
A dynamic microsimulation framework
- Homepage: https://neworder.readthedocs.io/
- Documentation: https://neworder.readthedocs.io/
- License: # MIT License Copyright © 2017-2025 Andrew P Smith Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. **THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.**
-
Latest release: 1.4.3
published 8 months ago
Rankings
Maintainers (1)
Dependencies
- mkdocs >=1.2.3
- mkdocs-macros-plugin >=0.6.4
- mkdocs-material >=8.2.5
- mkdocs-material-extensions >=1.0.3
- requests *
- Pillow ==9.0.1
- cycler ==0.11.0
- kiwisolver ==1.3.2
- matplotlib ==3.4.3
- mpi4py ==3.1.1
- neworder ==1.0.1
- numpy ==1.22.0
- pandas ==1.3.4
- pyparsing ==2.4.7
- python-dateutil ==2.8.2
- pytz ==2021.3
- scipy ==1.7.1
- six ==1.16.0
- Jinja2 >=3.0.1 development
- Markdown >=3.3.4 development
- MarkupSafe >=2.0.1 development
- PyYAML >=5.4.1 development
- Pygments >=2.9.0 development
- attrs >=21.2.0 development
- certifi >=2021.5.30 development
- chardet >=4.0.0 development
- click >=8.0.1 development
- ghp-import >=2.0.1 development
- idna >=2.10 development
- importlib-metadata >=4.6.1 development
- iniconfig >=1.1.1 development
- mergedeep >=1.3.4 development
- mkdocs >=1.2.1 development
- mkdocs-macros-plugin >=0.5.12 development
- mkdocs-material >=7.1.9 development
- mkdocs-material-extensions >=1.0.1 development
- mpi4py >=3.0.3 development
- numpy >=1.21.0 development
- packaging >=21.0 development
- pandas >=1.3.0 development
- pluggy >=0.13.1 development
- py >=1.10.0 development
- pybind11 >=2.6.2 development
- pymdown-extensions >=8.2 development
- pyparsing >=2.4.7 development
- pytest >=6.2.4 development
- python-dateutil >=2.8.1 development
- pytz >=2021.1 development
- pyyaml-env-tag >=0.1 development
- requests >=2.25.1 development
- six >=1.16.0 development
- termcolor >=1.1.0 development
- toml >=0.10.2 development
- urllib3 >=1.26.6 development
- watchdog >=2.1.3 development
- zipp >=3.5.0 development
- pandas >=1.0.5
- scipy *
- actions/checkout v3 composite
- conda-incubator/setup-miniconda v2 composite
- actions/checkout v3 composite
- actions/setup-python v4 composite
- actions/checkout v3 composite
- actions/upload-artifact v1 composite
- openjournals/openjournals-draft-action master composite
- actions/checkout v3 composite
- actions/setup-python v4 composite
- python 3.11 build