Updated the documents #1361
Open
Updated the documents #1361
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Updated geovisualizatipn, REDA.md, installation.rst
martinfleis
reviewed
Jan 20, 2025
README.md
Outdated
Comment on lines
91
to
92
| - [graph](https://pysal.org/libpysal/generated/libpysal.graph.Graph.html) : `graph` provides tools for creating, analyzing, and manipulating graph structures. It allows users to work with spatial networks, perform graph-based computations, and leverage graph algorithms to understand spatial relationships and patterns. This module enhances the capability of PySAL to handle complex spatial network analysis and supports various graph operations for spatial data. | ||
|
|
There was a problem hiding this comment.
Graph is a part of libpysal and as such is mentioned above. If anything, the line 30 should be updated to mention it. This does not belong here.
docs/api.rst
Outdated
| @@ -40,4 +40,6 @@ API Reference | |||
| ================================== | |||
| * `mapclassify: Choropleth Map Classification Schemes <https://pysal.org/mapclassify/api.html>`_ | |||
| * `splot: Lightweight Visualization Interface for PySAL Analytics <https://splot.readthedocs.io/en/latest/api.html#>`_ | |||
| * `legendgram: legendgrams legends that visualize the distribution of observations by color in a given map. <https://github.com/pysal/legendgram>`_ | |||
There was a problem hiding this comment.
I am not sure this is worth doing given the ongoing work on merging legendgram with mapclassify.
There was a problem hiding this comment.
I'd say so. Otherwise it'll stick here for another 5 years
Co-authored-by: Martin Fleischmann <martin@martinfleischmann.net>
martinfleis
requested changes
Jan 27, 2025
README.md
Outdated
| @@ -27,6 +27,9 @@ PySAL is a family of packages for spatial data science and is divided into four | |||
|
|
|||
| solve a wide variety of computational geometry problems including graph construction from polygonal lattices, lines, and points, construction and interactive editing of spatial weights matrices & graphs - computation of alpha shapes, spatial indices, and spatial-topological relationships, and reading and writing of sparse graph data, as well as pure python readers of spatial vector data. Unike other PySAL modules, these functions are exposed together as a single package. | |||
|
|
|||
| - [graph](https://pysal.org/libpysal/generated/libpysal.graph.Graph.html) : `graph` provides tools for creating, analyzing, and manipulating graph structures. It allows users to work with spatial networks, perform graph-based computations, and leverage graph algorithms to understand spatial relationships and patterns. This module enhances the capability of PySAL to handle complex spatial network analysis and supports various graph operations for spatial data. | |||
There was a problem hiding this comment.
graph is a part of libpysal on the same level as weights or cg.
docs/api.rst
Outdated
| @@ -40,4 +40,6 @@ API Reference | |||
| ================================== | |||
| * `mapclassify: Choropleth Map Classification Schemes <https://pysal.org/mapclassify/api.html>`_ | |||
| * `splot: Lightweight Visualization Interface for PySAL Analytics <https://splot.readthedocs.io/en/latest/api.html#>`_ | |||
| * `legendgram: legendgrams legends that visualize the distribution of observations by color in a given map. <https://github.com/pysal/legendgram>`_ | |||
There was a problem hiding this comment.
I'd say so. Otherwise it'll stick here for another 5 years
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
fixes #1324
Updated geovisualizatipn, READ.md, installation.rst
added legendgram to geovisualization, updated READ.md with graph module and added installation for graph in installation.rst
Hello! Please make sure to check all these boxes before submitting a Pull Request
(PR). Once you have checked the boxes, feel free to remove all text except the
justification in point 6.
pytest(see example command in.github/workflows/testing.yml).ruff. Formatting & linting are done automatically if you have installed the.pre-commit-config.yamlproperly in a local environment.pysal/mainbranch. This is important, as any PRs submitted against any other branches will be delayed.reviewer and added relevant labels (if possible)