Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
ni1o1 committed May 5, 2022
1 parent 1e2b228 commit a94fdf6
Show file tree
Hide file tree
Showing 21 changed files with 1,322 additions and 932 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,18 @@ Currently, `pybdshadow` mainly provides the following methods:

The target audience of `pybdshadow` includes data science researchers and data engineers in the field of BIM, GIS, energy, environment, and urban computing.

## Installation

It is recommended to use `Python 3.7, 3.8, 3.9`

### Using pypi [![PyPI version](https://badge.fury.io/py/pybdshadow.svg)](https://badge.fury.io/py/pybdshadow)

`pybdshadow` can be installed by using `pip install`. Before installing `pybdshadow`, make sure that you have installed the available [geopandas package](https://geopandas.org/en/stable/getting_started/install.html). If you already have geopandas installed, run the following code directly from the command prompt to install `pybdshadow`:

```python
pip install pybdshadow
```

## Usage

### Shadow generated by Sun light
Expand Down Expand Up @@ -98,18 +110,6 @@ Result of sunshine time on the ground:

![1651645530892.png](image/README/1651645530892.png)

## Installation

It is recommended to use `Python 3.7, 3.8, 3.9`

### Using pypi [![PyPI version](https://badge.fury.io/py/pybdshadow.svg)](https://badge.fury.io/py/pybdshadow)

`pybdshadow` can be installed by using `pip install`. Before installing `pybdshadow`, make sure that you have installed the available [geopandas package](https://geopandas.org/en/stable/getting_started/install.html). If you already have geopandas installed, run the following code directly from the command prompt to install `pybdshadow`:

```python
pip install pybdshadow
```

## Dependency

`pybdshadow` depends on the following packages
Expand Down
4 changes: 2 additions & 2 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@
author = 'Qing Yu'

# The full version, including alpha/beta/rc tags
release = '0.3.1'
version = '0.3.1'
release = '0.3.2'
version = '0.3.2'
html_logo = "_static/logo-wordmark-light.png"
html_favicon = '_static/logo.ico'
# -- General configuration ---------------------------------------------------
Expand Down
Loading

0 comments on commit a94fdf6

Please sign in to comment.