From 99d93d0f03857420dbf21b68362b1df175016ded Mon Sep 17 00:00:00 2001 From: James Gaboardi Date: Fri, 5 Jun 2020 16:32:17 -0400 Subject: [PATCH 1/4] adding mip info to blurb --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 37236857..0819be54 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ [![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) -Spopt is an open-source Python library for solving optimization problem with spatial data. Originating from the `region` module in [PySAL (Python Spatial Analysis Library)](http://pysal.org), it is under active development for the inclusion of newly proposed models and methods for regionalization, facility location, and transportation-oriented solutions. +Spopt is an open-source Python library for solving optimization problem with spatial data. Originating from the `region` module in [PySAL (Python Spatial Analysis Library)](http://pysal.org), it is under active development for the inclusion of newly proposed models and methods for regionalization, facility location, and transportation-oriented solutions. Spopt uses [`python-mip`](https://python-mip.readthedocs.io/en/latest/) under the hood for determining exact (non-heuristic) solutions. ### Regionalization From ade3bc29bd2f7d653cec46503385bbaaf15fedde Mon Sep 17 00:00:00 2001 From: James Gaboardi Date: Fri, 5 Jun 2020 16:35:27 -0400 Subject: [PATCH 2/4] adding contribution info to README --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 0819be54..2d2ee640 100644 --- a/README.md +++ b/README.md @@ -54,6 +54,10 @@ Coming Soon. ## Contribute +PySAL-spopt 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/spopt/issues) on GitHub. To submit patches, please review [PySAL: Getting Started](http://pysal.org/getting_started#for-developers), the PySAL [development guidelines](https://github.com/pysal/pysal/wiki), the `spopt` [contributing guidelines](https://github.com/pysal/spopt/blob/master/.github/CONTRIBUTING.md) before opening a [pull request](https://github.com/pysal/spopt/pulls). Once your changes get merged, you’ll automatically be added to the [Contributors List](https://github.com/pysal/spopt/graphs/contributors). + ## Support From a606763786ce7951b13287bccbf00654332d7178 Mon Sep 17 00:00:00 2001 From: James Gaboardi Date: Fri, 5 Jun 2020 16:40:14 -0400 Subject: [PATCH 3/4] adding in .github/CONTRIBUTING.md --- .github/CONTRIBUTING.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 .github/CONTRIBUTING.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 00000000..c02a0946 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,10 @@ +# Contributing Guidelines for `spopt` + +Thank you for your interest in contributing! We work primarily on Github. Please review the contributing procedures [here](http://pysal.org/getting_started#for-developers) and [here](https://github.com/pysal/pysal/wiki/GitHub-Standard-Operating-Procedures) so that we can accept your contributions! Alternatively, contact someone in the [development chat channel](https://gitter.im//pysal/pysal). + + +## Style and format + +1. Python 3.6, 3.7, and 3.8 are the officially supported versions. +2. This project follows the formatting conventions of [`black`](https://black.readthedocs.io/en/stable/) and utilizes [`pre-commit`](https://pre-commit.com) to format commits prior to pull requests being made. + * LJ Miranda provides an [excellent, concise guide](https://ljvmiranda921.github.io/notebook/2018/06/21/precommits-using-black-and-flake8/) on setting up and implementing a `pre-commit` hook for `black`. From ea0ef74a291a1aef1574349b37a7f7acef7578ab Mon Sep 17 00:00:00 2001 From: James Gaboardi Date: Fri, 5 Jun 2020 16:47:01 -0400 Subject: [PATCH 4/4] removing CONTRIBUTING --> .github/CONTRIBUTING.md --- CONTRIBUTING.md | 10 ---------- 1 file changed, 10 deletions(-) delete mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index c02a0946..00000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,10 +0,0 @@ -# Contributing Guidelines for `spopt` - -Thank you for your interest in contributing! We work primarily on Github. Please review the contributing procedures [here](http://pysal.org/getting_started#for-developers) and [here](https://github.com/pysal/pysal/wiki/GitHub-Standard-Operating-Procedures) so that we can accept your contributions! Alternatively, contact someone in the [development chat channel](https://gitter.im//pysal/pysal). - - -## Style and format - -1. Python 3.6, 3.7, and 3.8 are the officially supported versions. -2. This project follows the formatting conventions of [`black`](https://black.readthedocs.io/en/stable/) and utilizes [`pre-commit`](https://pre-commit.com) to format commits prior to pull requests being made. - * LJ Miranda provides an [excellent, concise guide](https://ljvmiranda921.github.io/notebook/2018/06/21/precommits-using-black-and-flake8/) on setting up and implementing a `pre-commit` hook for `black`.