Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

convert README to markdown #598

Merged
merged 2 commits into from
Oct 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Python Spatial Analysis Library Core

[![Continuous Integration](https://github.com/pysal/libpysal/actions/workflows/unittests.yml/badge.svg)](https://github.com/pysal/libpysal/actions/workflows/unittests.yml)
[![codecov](https://codecov.io/gh/pysal/libpysal/branch/main/graph/badge.svg)](https://codecov.io/gh/pysal/libpysal)
[![PyPI version](https://badge.fury.io/py/libpysal.svg)](https://badge.fury.io/py/libpysal)
[![Conda Version](https://img.shields.io/conda/vn/conda-forge/libpysal.svg)](https://anaconda.org/conda-forge/libpysal)
[![DOI](https://zenodo.org/badge/81501824.svg)](https://zenodo.org/badge/latestdoi/81501824)

## libpysal modules

- `libpysal.cg` – Computational geometry
- `libpysal.io` – Input and output
- `libpysal.weights` – Spatial weights
- `libpysal.examples` – Built-in example datasets

## Example Notebooks

- [Spatial Weights](notebooks/weights.ipynb)
- [Voronoi](notebooks/voronoi.ipynb)
- [Input and Output](notebooks/io.ipynb)

## Development

libpysal development is hosted on [github](https://github.com/pysal/libpysal).

Discussions of development occurs on the [developer list](http://groups.google.com/group/pysal-dev) as well as [gitter](https://gitter.im/pysal/pysal?).

## Contributing

PySAL-libpysal is under active development and contributors are welcome. If you have any suggestions, feature requests, or bug reports, please open new [issues](https://github.com/pysal/libpysal/issues) on GitHub. To submit patches, please review [PySAL's documentation for developers](https://pysal.org/docs/devs/), the PySAL [development guidelines](https://github.com/pysal/pysal/wiki), and the [libpysal contributing guidelines](https://github.com/pysal/libpysal/blob/main/.github/CONTRIBUTING.md)
before opening a [pull request](https://github.com/pysal/libpysal/pulls). Once your changes get merged, you’ll automatically be added to the [Contributors List](https://github.com/pysal/libpysal/graphs/contributors).

## Bug reports

To search for or report bugs, please see [libpysal's issues](https://github.com/pysal/libpysal/issues).

## License information

See [LICENSE.txt](https://github.com/pysal/libpysal/blob/main/LICENSE.txt) for information on the history of this software, terms & conditions for usage, and a DISCLAIMER OF ALL WARRANTIES.
81 changes: 0 additions & 81 deletions README.rst

This file was deleted.

2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ maintainers = [{ name = "PySAL Developers" }]
license = { text = "BSD 3-Clause" }
description = "Core components of PySAL - A library of spatial analysis functions"
keywords = ["spatial statistics", "spatial graphs"]
readme = "README.rst"
readme = "README.md"
classifiers = [
"Programming Language :: Python :: 3",
"License :: OSI Approved :: BSD License",
Expand Down