Skip to content

Commit

Permalink
Merge pull request #627 from jGaboardi/rebuild_docs_verison_bump
Browse files Browse the repository at this point in the history
Rebuild docs for version bump
  • Loading branch information
jGaboardi authored Jun 4, 2021
2 parents f1c529b + d7efdef commit b4b273c
Show file tree
Hide file tree
Showing 17 changed files with 1,179 additions and 1,091 deletions.
38 changes: 37 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,29 @@ $ pip install git+https://github.com/pysal/spaghetti
- [`shapely`](https://shapely.readthedocs.io/en/latest/)


##

`spaghetti` was
created and has evolved in line with the Python Spatial Analysis Library ecosystem for
the specific purpose of utilizing the functionality of spatial weights in
[`libpysal`](https://pysal.org/libpysal/) for generating network segment contiguity objects.
The PySAL project was started in the mid-2000s when installation was difficult to maintain.
Due to the non-triviality of relying on dependencies to secondary packages, a conscious
decision was made to limit dependencies and build native PySAL data structures in cases
where at all possible. Therefore, the original `pysal.network` submodule was developed to
address the need for integrating support for network data structures with PySAL weights
data structures, with the target audience being spatial data scientists and anyone
interested in investigating network-centric phenomena within PySAL. Owing to the
co-development of network functionality found within `spaghetti` and the evolution of
the wider PySAL ecosystem, today, the package provides specialized network functionality
that easily integrates with the rest of PySAL. This allows users of `spaghetti`’s network
functionality to access spatial analysis functionality that complements network analysis,
such as spatial statistical tools with `esda` and integration with core components of
`libpysal`: `libpysal.weights` (mentioned above),
`libpysal.cg` (computational geometry and data structures),
`libpysal.io` (input-output), and `libpysal.examples` (built-in example data).


## Contribute

PySAL-spaghetti is under active development and contributors are welcome.
Expand All @@ -105,9 +128,22 @@ The project is licensed under the [BSD 3-Clause license](https://github.com/pysa

## BibTeX Citation

If you use PySAL-spaghetti in a scientific publication, we would appreciate using the following citation:
If you use PySAL-spaghetti in a scientific publication, we would appreciate using the following citations:

```
@article{Gaboardi2021,
doi = {10.21105/joss.02826},
url = {https://doi.org/10.21105/joss.02826},
year = {2021},
publisher = {The Open Journal},
volume = {6},
number = {62},
pages = {2826},
author = {James D. Gaboardi and Sergio Rey and Stefanie Lumnitz},
title = {spaghetti: spatial network analysis in PySAL},
journal = {Journal of Open Source Software}
}
@misc{Gaboardi2018,
author = {Gaboardi, James D. and Laura, Jay and Rey, Sergio and
Wolf, Levi John and Folch, David C. and Kang, Wei and
Expand Down
13 changes: 13 additions & 0 deletions docs/_static/references.bib
Original file line number Diff line number Diff line change
Expand Up @@ -605,3 +605,16 @@ @book{moran:_cliff81
Title = {Spatial Processes: Models and Applications},
Year = {1981}
}

@article{Gaboardi2021,
doi = {10.21105/joss.02826},
url = {https://doi.org/10.21105/joss.02826},
year = {2021},
publisher = {The Open Journal},
volume = {6},
number = {62},
pages = {2826},
author = {James D. Gaboardi and Sergio Rey and Stefanie Lumnitz},
title = {spaghetti: spatial network analysis in PySAL},
journal = {Journal of Open Source Software}
}
41 changes: 39 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,30 @@ and usage tutorials are provided here through the links above.
</div>


History
-------

`Spaghetti` was
created and has evolved in line with the Python Spatial Analysis Library ecosystem for
the specific purpose of utilizing the functionality of spatial weights in
`libpysal <https://pysal.org/libpysal/>`_ for generating network segment contiguity objects.
The PySAL project was started in the mid-2000s when installation was difficult to maintain.
Due to the non-triviality of relying on dependencies to secondary packages, a conscious
decision was made to limit dependencies and build native PySAL data structures in cases
where at all possible. Therefore, the original `pysal.network` submodule was developed to
address the need for integrating support for network data structures with PySAL weights
data structures, with the target audience being spatial data scientists and anyone
interested in investigating network-centric phenomena within PySAL. Owing to the
co-development of network functionality found within `spaghetti` and the evolution of
the wider PySAL ecosystem, today, the package provides specialized network functionality
that easily integrates with the rest of PySAL. This allows users of `spaghetti`’s network
functionality to access spatial analysis functionality that complements network analysis,
such as spatial statistical tools with `esda` and integration with core components of
`libpysal`: `libpysal.weights` (mentioned above),
`libpysal.cg` (computational geometry and data structures),
`libpysal.io` (input-output), and `libpysal.examples` (built-in example data).


Development
-----------

Expand All @@ -76,8 +100,21 @@ Development of `spaghetti` is hosted on GitHub_.
Citing `spaghetti`
------------------

If you use PySAL-spaghetti in a scientific publication, we would appreciate using the following BibTeX citation::

If you use PySAL-spaghetti in a scientific publication, we would appreciate using the following BibTeX citations::

@article{Gaboardi2021,
doi = {10.21105/joss.02826},
url = {https://doi.org/10.21105/joss.02826},
year = {2021},
publisher = {The Open Journal},
volume = {6},
number = {62},
pages = {2826},
author = {James D. Gaboardi and Sergio Rey and Stefanie Lumnitz},
title = {spaghetti: spatial network analysis in PySAL},
journal = {Journal of Open Source Software}
}
@misc{Gaboardi2018,
author = {Gaboardi, James D. and Laura, Jay and Rey, Sergio and
Wolf, Levi John and Folch, David C. and Kang, Wei and
Expand Down
Loading

0 comments on commit b4b273c

Please sign in to comment.