| Name | colocationpy JSON |
| Version |
0.1.8
JSON |
| download |
| home_page | None |
| Summary | Tools for co-location analysis: metrics, transforms, and utilities. |
| upload_time | 2025-08-29 16:28:23 |
| maintainer | None |
| docs_url | None |
| author | Keiran Suchak |
| requires_python | >=3.10 |
| license | BSD 3-Clause License
Copyright (c) 2025, Keiran Suchak
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
| keywords |
co-location
spatial
mobility
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# `colocationpy`
[](https://github.com/ksuchak1990/colocationpy/actions/workflows/ruff.yml)
[](https://github.com/ksuchak1990/colocationpy/actions/workflows/pytest.yml)
> A package to identify instances of co-location between mobile individuals in a
> population.
The package provides:
* **Core functionality** for detecting when and where co-location occurs.
* **Supporting metrics** for analysing the outcomes of co-location (entropy, clustering, interaction networks, modularity, etc.).
* **Transformations and utilities** to handle spatial and temporal alignment, distances, and proximity checks.
## Installation
```bash
pip install colocationpy
```
## Quickstart
Import the library and detect co-locations from mobility data, then use the built-in tools to explore the results.
Example outline:
* Provide trajectories with individual IDs, positions, and timestamps.
* Use co-location utilities to compute who was in the same place at the same time.
* Analyse the resulting interaction network or entropy measures.
## Modules
* **colocationpy (top-level)**
Main API: co-location detection and related helpers.
* **colocationpy.metrics**
Functions to analyse co-location results: entropies, clustering coefficient, interaction networks, mutual information, modularity.
* **colocationpy.transformations**
Functions to align coordinate systems and map simulation timesteps to real datetimes. Used to make heterogeneous mobility data comparable.
* **colocationpy.utils**
Distance measures, proximity functions, barrier handling, and other helpers used internally and available for advanced users.
Raw data
{
"_id": null,
"home_page": null,
"name": "colocationpy",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "co-location, spatial, mobility",
"author": "Keiran Suchak",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/f0/93/749a4f9d4fe62492fb62775a05ad35e8352f16d874482874b5c1409b68e5/colocationpy-0.1.8.tar.gz",
"platform": null,
"description": "# `colocationpy`\n\n[](https://github.com/ksuchak1990/colocationpy/actions/workflows/ruff.yml)\n\n[](https://github.com/ksuchak1990/colocationpy/actions/workflows/pytest.yml)\n\n> A package to identify instances of co-location between mobile individuals in a\n> population.\n\nThe package provides:\n\n* **Core functionality** for detecting when and where co-location occurs.\n* **Supporting metrics** for analysing the outcomes of co-location (entropy, clustering, interaction networks, modularity, etc.).\n* **Transformations and utilities** to handle spatial and temporal alignment, distances, and proximity checks.\n\n## Installation\n\n```bash\npip install colocationpy\n```\n\n## Quickstart\n\nImport the library and detect co-locations from mobility data, then use the built-in tools to explore the results.\n\nExample outline:\n\n* Provide trajectories with individual IDs, positions, and timestamps.\n* Use co-location utilities to compute who was in the same place at the same time.\n* Analyse the resulting interaction network or entropy measures.\n\n## Modules\n\n* **colocationpy (top-level)**\n Main API: co-location detection and related helpers.\n\n* **colocationpy.metrics**\n Functions to analyse co-location results: entropies, clustering coefficient, interaction networks, mutual information, modularity.\n\n* **colocationpy.transformations**\n Functions to align coordinate systems and map simulation timesteps to real datetimes. Used to make heterogeneous mobility data comparable.\n\n* **colocationpy.utils**\n Distance measures, proximity functions, barrier handling, and other helpers used internally and available for advanced users.\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License\n \n Copyright (c) 2025, Keiran Suchak\n \n Redistribution and use in source and binary forms, with or without\n modification, are permitted provided that the following conditions are met:\n \n 1. Redistributions of source code must retain the above copyright notice, this\n list of conditions and the following disclaimer.\n \n 2. Redistributions in binary form must reproduce the above copyright notice,\n this list of conditions and the following disclaimer in the documentation\n and/or other materials provided with the distribution.\n \n 3. Neither the name of the copyright holder nor the names of its\n contributors may be used to endorse or promote products derived from\n this software without specific prior written permission.\n \n THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\"\n AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\n IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\n DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE\n FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\n DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR\n SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER\n CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,\n OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\n OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n ",
"summary": "Tools for co-location analysis: metrics, transforms, and utilities.",
"version": "0.1.8",
"project_urls": {
"Homepage": "https://github.com/ksuchak1990/colocationpy/",
"Issues": "https://github.com/ksuchak1990/colocationpy/issues"
},
"split_keywords": [
"co-location",
" spatial",
" mobility"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "13c2f5a6521c815a53fa3753f2295550b6bfb8ea7a50b7234c240ed6af3e8056",
"md5": "0f63853d3f5fb18cccb8cd9358af19a4",
"sha256": "a6744ccd9d0a6c50d39bd332c93c96f000d53b092afbb1233087c0aa923c8d96"
},
"downloads": -1,
"filename": "colocationpy-0.1.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0f63853d3f5fb18cccb8cd9358af19a4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 16722,
"upload_time": "2025-08-29T16:28:22",
"upload_time_iso_8601": "2025-08-29T16:28:22.521016Z",
"url": "https://files.pythonhosted.org/packages/13/c2/f5a6521c815a53fa3753f2295550b6bfb8ea7a50b7234c240ed6af3e8056/colocationpy-0.1.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "f093749a4f9d4fe62492fb62775a05ad35e8352f16d874482874b5c1409b68e5",
"md5": "17e7ec0b25d0b5afd6e06dfda06110af",
"sha256": "da40e7b4163f65d61aec12e093ceb1ee913202dd5e206faeb9a4d5eea5644760"
},
"downloads": -1,
"filename": "colocationpy-0.1.8.tar.gz",
"has_sig": false,
"md5_digest": "17e7ec0b25d0b5afd6e06dfda06110af",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 22316,
"upload_time": "2025-08-29T16:28:23",
"upload_time_iso_8601": "2025-08-29T16:28:23.916189Z",
"url": "https://files.pythonhosted.org/packages/f0/93/749a4f9d4fe62492fb62775a05ad35e8352f16d874482874b5c1409b68e5/colocationpy-0.1.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-29 16:28:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ksuchak1990",
"github_project": "colocationpy",
"github_not_found": true,
"lcname": "colocationpy"
}
