Metadata-Version: 2.1
Name: cdcam
Version: 1.0.0
Summary: Cambridge Digital Communications Assessment Model
Home-page: https://github.com/edwardoughton/cdcam
Author: Edward J. Oughton
Author-email: edward.oughton@ouce.ox.ac.uk
License: MIT License
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Communications :: Telephony
Description-Content-Type: text/markdown

Cambridge Digital Communications Assessment Model (cdcam)
=========================================================

[![Documentation Status](https://readthedocs.org/projects/cdcam/badge/?version=latest)](https://cdcam.readthedocs.io/en/latest/?badge=latest)
[![Build Status](https://travis-ci.com/nismod/cdcam.svg?branch=master)](https://travis-ci.com/nismod/cdcam)
[![Coverage Status](https://coveralls.io/repos/github/nismod/cdcam/badge.svg?branch=master)](https://coveralls.io/github/nismod/cdcam?branch=master)

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](http://conda.pydata.org/miniconda.html),
which handles packages and virtual environments, along with the
[`conda-forge`](https://conda-forge.org/) 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](https://doi.org/10.5281/zenodo.3525285), then run:

    python scripts/run.py

More details are provided in the [Getting
Started](https://cdcam.readthedocs.io/en/latest/getting-started.html) documentation.


Background and funding
======================

The **Cambridge Digital Communications Assessment Model** has been collaboratively developed
between the [Environmental Change Institute](http://www.eci.ox.ac.uk/) at the [University of
Oxford](https://www.ox.ac.uk/), the [Networks and Operating Systems Group
(NetOS)](http://www.cl.cam.ac.uk/research/srg/netos) at the [Cambridge Computer
Laboratory](http://www.cl.cam.ac.uk),  and the UK's [Digital
Catapult](http://www.digtalcatapult.org.uk). Research activity between 2017-2018 also took
place at the [Cambridge Judge Business School](http://www.jbs.cam.ac.uk/home/) at the
[University of Cambridge](http://www.cam.ac.uk/).

Development has been funded by the EPSRC via (i) the [Infrastructure Transitions Research
Consortium](http://www.itrc.org.uk/) (EP/N017064/1) and (ii) the UK's [Digital
Catapult](http://www.digicatapult.org.uk) Researcher in Residence programme.

Contributors
============
- Edward J. Oughton (University of Oxford)
- Tom Russell (University of Oxford)


