Skip to content

Commit 74c3fda

Browse files
authored
Merge pull request #53 from jGaboardi/codecov_in_action
README cleanup and report code coverage
2 parents fae19a6 + c3b6404 commit 74c3fda

3 files changed

Lines changed: 24 additions & 43 deletions

File tree

.github/workflows/testing.yml

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ jobs:
5151
fetch-depth: 0
5252

5353
- name: setup micromamba
54-
uses: mamba-org/setup-micromamba@v2
54+
uses: mamba-org/setup-micromamba@v3
5555
with:
5656
environment-file: ${{ matrix.environment-file }}
5757
micromamba-version: 'latest'
@@ -82,9 +82,7 @@ jobs:
8282
-n logical \
8383
--color yes
8484
85-
#- name: codecov
86-
# uses: codecov/codecov-action@v5
87-
# with:
88-
# token: ${{ secrets.CODECOV_TOKEN }}
89-
# file: ./coverage.xml
90-
# name: spint-codecov
85+
- name: codecov
86+
uses: codecov/codecov-action@v6
87+
with:
88+
token: ${{ secrets.CODECOV_TOKEN }}

README.md

Lines changed: 17 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,19 @@
1-
Spatial Interaction Modeling Package
2-
===========================================
1+
# Spatial Interaction Modeling Package
32

43
[![Continuous Integration](https://github.com/pysal/spint/actions/workflows/testing.yml/badge.svg)](https://github.com/pysal/spint/actions/workflows/testing.yml)
4+
[![codecov](https://codecov.io/gh/pysal/spint/branch/main/graph/badge.svg?token=VNn0WR5JWT)](https://codecov.io/gh/pysal/spint)
55
[![Documentation Status](https://readthedocs.org/projects/spint/badge/?version=latest)](https://spint.readthedocs.io/en/latest/?badge=latest)
66
[![PyPI version](https://badge.fury.io/py/spint.svg)](https://badge.fury.io/py/spint)
77
[![Conda Version](https://img.shields.io/conda/vn/conda-forge/spint.svg)](https://anaconda.org/conda-forge/spint)
88
[![SPEC 0 — Minimum Supported Dependencies](https://img.shields.io/badge/SPEC-0-green?labelColor=%23004811&color=%235CA038)](https://scientific-python.org/specs/spec-0000/)
99

1010
The **Sp**atial **Int**eraction Modeling (SpInt) module seeks to provide a collection of tools to study spatial interaction processes and analyze spatial interaction data.
1111

12-
The [initial development](https://github.com/pysal/pysal/wiki/SpInt-Development) of the module was carried out as a Google Summer of Code
13-
project (summer 2016). Documentation of the project progress can be found on the
14-
[project blog](https://tayloroshan.github.io/).
12+
The [initial development](https://github.com/pysal/pysal/wiki/SpInt-Development) of the module was carried out as a Google Summer of Code project (summer 2016). Documentation of the project progress can be found on the [project blog](https://tayloroshan.github.io/).
1513

1614
The module currently supports the calibration of the 'family' of spatial interaction models (Wilson, 1971) which are derived using an entropy maximizing (EM) framework or the equivalent information minimizing (IM) framework. As such, it is able to derive parameters for the following Poisson count models:
1715

18-
Models
19-
------
16+
## Models
2017

2118
- unconstrained gravity model
2219
- production-constrained model (origin-constrained)
@@ -25,45 +22,32 @@ Models
2522

2623
Calibration is carried out using iteratively weighted least squares in a generalized linear modleing framework (Cameron & Trivedi, 2013). These model results have been verified against comparable routines laid out in (Fotheringham and O’Kelly, 1989; Willimans and Fotheringham, 1984) and functions avaialble in R such as GL or Pythons statsmodels. The estimation of the constrained routines are carried out using sparse data strucutres for lower memory overhead and faster computations.
2724

28-
Additional Features
29-
-------------------
25+
## Additional Features
3026

3127
- QuasiPoisson model estimation
3228
- Regression-based tests for overdispersion
33-
- Model fit statistics including typical GLM metrics, standardized root mean
34-
square error, and Sorensen similarit index
35-
- Vector-based Moran's I statistic for testing for spatial autcorrelation in
36-
spatial interaction data
37-
- Local subset model calibration for mappable sets of parameter estimates and model
38-
diagnostics
39-
- Three types of spatial interaction spatial weights: origin-destination
40-
contiguity weights, network-based weights, and vector-based distance weights
29+
- Model fit statistics including typical GLM metrics, standardized root mean square error, and Sorensen similarit index
30+
- Vector-based Moran's I statistic for testing for spatial autcorrelation in spatial interaction data
31+
- Local subset model calibration for mappable sets of parameter estimates and model diagnostics
32+
- Three types of spatial interaction spatial weights: origin-destination contiguity weights, network-based weights, and vector-based distance weights
4133

42-
In Progress
43-
-----------
34+
## In Progress
4435

4536
- Spatial Autoregressive (Lag) model spatial interaction specification
4637

47-
Future Work
48-
-----------
38+
## Future Work
4939

5040
- Parameter estimation via maximum likelihood and gradient-based optimization
5141
- Zero-inflated Poisson model
5242
- Negative Binomial model/zero-inflated negative binomial model
5343
- Functions to compute competing destinations
5444
- Functions to compute eigenvector spatial filters
5545
- Parameter estimation via neural networks
56-
- Universal (determinsitic) models such as the Radiation model and Inverse
57-
Population Weighted model
46+
- Universal (determinsitic) models such as the Radiation model and Inverse Population Weighted model
5847

59-
Cameron, C. A. and Trivedi, P. K. (2013). Regression analyis of count data.
60-
Cambridge University Press, 1998.
48+
## Background
6149

62-
Fotheringham, A. S. and O'Kelly, M. E. (1989). Spatial Interaction Models: Formulations and Applications. London: Kluwer Academic Publishers.
63-
64-
Williams, P. A. and A. S. Fotheringham (1984), The Calibration of Spatial Interaction
65-
Models by Maximum Likelihood Estimation with Program SIMODEL, Geographic Monograph
66-
Series, 7, Department of Geography, Indiana University.
67-
68-
Wilson, A. G. (1971). A family of spatial interaction models, and associated developments. Environment and
69-
Planning A, 3, 1–32.
50+
* **Cameron, C. A. and Trivedi, P. K.** (2014). *Regression analyis of count data*. Cambridge University Press. DOI: [10.1017/CBO9781139013567](https://doi.org/10.1017/CBO9781139013567)
51+
* **Fotheringham, A. S. and O'Kelly, M. E.** (1989). *Spatial Interaction Models: Formulations and Applications*. London: Kluwer Academic Publishers.
52+
* **Williams, P. A. and Fotheringham, A. S.** (1984), *The Calibration of Spatial Interaction Models by Maximum Likelihood Estimation with Program SIMODEL*, Geographic Monograph Series, 7, Department of Geography, Indiana University.
53+
* **Wilson, A. G.** (1971). *A Family of Spatial Interaction Models, and Associated Developments*. Environment and Planning A, 3, 1–32. DOI: [10.1068/a030001](https://doi.org/10.1068/a030001)

doc/installation.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Installation
44
============
55

66

7-
spint supports python `3.5`_ and `3.6`_ only. Please make sure that you are
7+
spint supports python >= `3.12`_. Please make sure that you are
88
operating in a python 3 environment.
99

1010
Installing released version
@@ -37,8 +37,7 @@ your fork. By making changes
3737
to your local clone and submitting a pull request to `pysal/spint`_, you can
3838
contribute to the mgwr development.
3939

40-
.. _3.5: https://docs.python.org/3.5/
41-
.. _3.6: https://docs.python.org/3.6/
40+
.. _3.12: https://docs.python.org/3.12/
4241
.. _Python Package Index: https://pypi.org/project/spglm/
4342
.. _pysal/spint: https://github.com/pysal/spint
4443
.. _fork: https://help.github.com/articles/fork-a-repo/

0 commit comments

Comments
 (0)