Metadata-Version: 2.4
Name: sgGWR
Version: 0.1.5a0
Author-email: Hayato Nishi <hnishiua@gmail.com>
License: BSD 3-Clause License
        
        Copyright (c) 2023, Hayato Nishi
        
        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.
        
Project-URL: Homepage, https://github.com/hayato-n/sgGWR
Project-URL: Documentation, https://hayato-n.github.io/sgGWR/
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: tqdm>=4.60.0
Requires-Dist: scipy>=1.6.2
Requires-Dist: numpy>=1.19.2
Provides-Extra: jax
Requires-Dist: optax>=0.0.9; extra == "jax"
Requires-Dist: jax>=0.2.12; extra == "jax"
Provides-Extra: dev
Requires-Dist: build; extra == "dev"
Requires-Dist: twine; extra == "dev"
Dynamic: license-file

# sgGWR

## Installation
We recommend installing [JAX](https://github.com/google/jax) package for efficient computation.
To install sgGWR with JAX, please execute the following on your terminal.

```
pip install sgGWR[jax]
```

If you cannot install JAX (e.g., Windows users), you can omit `[jax]` option.

```
pip install sgGWR
```


## Reference


Please cite the following article:

- Nishi, H., & Asami, Y. (2024). Stochastic gradient geographical weighted regression (sgGWR): Scalable bandwidth optimization for geographically weighted regression. International Journal of Geographical Information Science, 38(2), 354–380. https://doi.org/10.1080/13658816.2023.2285471


