Skip to content

Updated the documents#1361

Open
speco29 wants to merge 6 commits into
pysal:mainfrom
speco29:create-docs
Open

Updated the documents#1361
speco29 wants to merge 6 commits into
pysal:mainfrom
speco29:create-docs

Conversation

@speco29

@speco29 speco29 commented Jan 20, 2025

Copy link
Copy Markdown

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.

  1. You have run tests on this submission locally with pytest (see example command in .github/workflows/testing.yml).
  2. This submission is formatted and linted with ruff. Formatting & linting are done automatically if you have installed the .pre-commit-config.yaml properly in a local environment.
  3. If this PR adds or updates the codebase, appropriate adjustments are made to corresponding docstrings and changes are covered (see (1.) above).
  4. This pull request is directed to the pysal/main branch. This is important, as any PRs submitted against any other branches will be delayed.
  5. You have assigned a
    reviewer
    and added relevant labels (if possible)
  6. The justification for this PR is:
    • Add justification here

Updated geovisualizatipn, REDA.md, installation.rst
Comment thread 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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread docs/api.rst Outdated
==================================
* `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>`_

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure this is worth doing given the ongoing work on merging legendgram with mapclassify.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should I remove it then?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd say so. Otherwise it'll stick here for another 5 years

Comment thread docs/installation.rst Outdated
speco29 and others added 3 commits January 20, 2025 15:17
Comment thread README.md Outdated

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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

graph is a part of libpysal on the same level as weights or cg.

Comment thread docs/api.rst Outdated
==================================
* `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>`_

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

update docs & README

2 participants