cdcam
cdcam: Cambridge Digital Communications Assessment Model - Published in JOSS (2020)
Science Score: 93.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 13 DOI reference(s) in README and JOSS metadata -
✓Academic publication links
Links to: joss.theoj.org, zenodo.org -
○Committers with academic emails
-
○Institutional organization owner
-
✓JOSS paper metadata
Published in Journal of Open Source Software
Scientific Fields
Repository
Cambridge Digital Communications Assessment Model
Basic Info
- Host: GitHub
- Owner: nismod
- License: mit
- Language: Python
- Default Branch: master
- Size: 55 MB
Statistics
- Stars: 0
- Watchers: 3
- Forks: 5
- Open Issues: 2
- Releases: 1
Metadata Files
README.md
Cambridge Digital Communications Assessment Model (cdcam)
Description
The Cambridge Digital Communications Assessment Model (cdcam) is a decision support tool
to quantify the performance of national digital infrastructure strategies for mobile broadband,
focussing on 4G and 5G technologies.
Citations
- Oughton, E.J. and Frias, Z. (2017) The Cost, Coverage and Rollout Implications of 5G Infrastructure in Britain. Telecommunications Policy. https://doi.org/10.1016/j.telpol.2017.07.009.
- Oughton, E.J., Z. Frias, T. Russell, D. Sicker, and D.D. Cleevely. 2018. Towards 5G: Scenario-Based Assessment of the Future Supply and Demand for Mobile Telecommunications Infrastructure. Technological Forecasting and Social Change, 133 (August): 141–55. https://doi.org/10.1016/j.techfore.2018.03.016.
- Oughton, E.J., Frias, Z., van der Gaast, S. and van der Berg, R. (2019) Assessing the Capacity, Coverage and Cost of 5G Infrastructure Strategies: Analysis of The Netherlands. Telematics and Informatics (January). https://doi.org/10.1016/j.tele.2019.01.003.
Setup and configuration
All code for The Cambridge Digital Communications Assessment Model is written in Python (Python>=3.5). The core model has no other dependencies.
See requirements-dev.txt for a full list of optional dependencies used in supporting
scripts.
Using conda
The recommended installation method is to use conda,
which handles packages and virtual environments, along with the
conda-forge channel which has a host of pre-built libraries and
packages.
Create a conda environment called cdcam:
conda create --name cdcam python=3.7
Activate it (run this each time you switch projects):
conda activate cdcam
First, install optional packages:
conda install fiona shapely rtree pyproj tqdm
Then install cdcam:
pip install cdcam
Alternatively, for development purposes, clone this repository and run:
python setup.py develop
Install test/dev requirements:
conda install pytest pytest-cov
Run the tests:
pytest --cov-report=term --cov=cdcam tests/
Quick start
If you want to quickly generate results, first download the sample dataset available at DOI 10.5281/zenodo.3525285, then run:
python scripts/run.py
You should see the model printing output such as Running: baseline baseline macrocell
which means the data have been loaded and you are running the baseline population scenario,
baseline data throughput scenario and macrocell upgrade strategy.
You should then see an output for each year (- 2020) indicating how much money was spent on
either servicing a specified coverage obligation (Service) or in meeting demand (Demand):
- 2020
Service 0
Demand 14614
- 2021
Service 0
Demand 3293
More details are provided in the Getting Started documentation.
Contributions
Contributions to this package are welcomed via the usual pull request mechanism.
Support
If you encounter a bug, feel the documentation is incorrect or incomplete, or want to suggest new features, please post an issue in the issues tab.
DAFNI
DAFNI provides another environment to run the model.
To prepare the model for DAFNI, there are two elements: - build a docker container image, and upload as a DAFNI model - prepare the project data files, and upload as DAFNI datasets
DAFNI model
To build a docker image, install docker and check out this repository.
The Dockerfile defines how the model image is built. The image includes a python
environment with cdcam installed, and the run.py and dafni-run.sh scripts.
To build and export, run:
bash
docker build . -t nismod/cdcam
docker save nismod/cdcam | gzip > cdcam.tar.gz
Then upload the cdcam.tar.gz file along with the dafni-model-definition.yml
as a model to DAFNI.
DAFNI data
The DAFNI model uses "dataslots" to input the project data files. Initially, the project sample data package (also available on Zenodo) has been uploaded.
Background and funding
The Cambridge Digital Communications Assessment Model has been collaboratively developed between the Environmental Change Institute at the University of Oxford, the Networks and Operating Systems Group (NetOS) at the Cambridge Computer Laboratory, and the UK's Digital Catapult. Research activity between 2017-2018 also took place at the Cambridge Judge Business School at the University of Cambridge.
Development has been funded by the EPSRC via (i) the Infrastructure Transitions Research Consortium (EP/N017064/1) and (ii) the UK's Digital Catapult Researcher in Residence programme.
Contributors
- Edward J. Oughton (University of Oxford)
- Tom Russell (University of Oxford)
Owner
- Name: National Infrastructure Systems Model
- Login: nismod
- Kind: organization
- Location: United Kingdom
- Website: www.itrc.org.uk
- Repositories: 30
- Profile: https://github.com/nismod
JOSS Publication
cdcam: Cambridge Digital Communications Assessment Model
Authors
Environmental Change Institute, University of Oxford, Computer Laboratory, University of Cambridge
Environmental Change Institute, University of Oxford
Editor
Melissa Weber Mendonça
Tags
python mobile telecommunications technoeconomic simulation 5GGitHub Events
Total
Last Year
Committers
Last synced: 5 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| ej550 | e****n@g****m | 89 |
| Tom Russell | t****l@g****m | 75 |
Issues and Pull Requests
Last synced: 4 months ago
All Time
- Total issues: 4
- Total pull requests: 17
- Average time to close issues: 30 days
- Average time to close pull requests: 3 months
- Total issue authors: 4
- Total pull request authors: 2
- Average comments per issue: 2.75
- Average comments per pull request: 0.0
- Merged pull requests: 16
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- nmstreethran (1)
- tomalrussell (1)
- ethanyxchen (1)
- potterzot (1)
Pull Request Authors
- edwardoughton (13)
- tomalrussell (4)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 30 last-month
- Total dependent packages: 0
- Total dependent repositories: 1
- Total versions: 3
- Total maintainers: 2
pypi.org: cdcam
Cambridge Digital Communications Assessment Model
- Homepage: https://github.com/nismod/cdcam
- Documentation: https://cdcam.readthedocs.io/
- License: MIT License
-
Latest release: 1.0.1
published about 6 years ago
Rankings
Maintainers (2)
Dependencies
- pylint * development
- pytest >=3.6 development
- pytest-cov * development
- sphinx *
- fiona >=1.8.13
- pyproj >=2.4
- rtree >=0.8
- shapely >=1.6
- tqdm *
- eg *
- six >=1.7
- python 3.6 build