Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
giswqs committed Apr 17, 2022
1 parent 167350e commit 170b433
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 7 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
[![image](https://img.shields.io/badge/YouTube-Channel-red)](https://www.youtube.com/c/QiushengWu)
[![image](https://img.shields.io/twitter/follow/giswqs?style=social)](https://twitter.com/giswqs)

**A collection of Python packages for geosptial analysis and data visualization.**
**A Python package for installing commonly used packages for geospatial analysis and data visualization with only one command.**

- Free software: MIT license
- Documentation: https://geospatial.gishub.org
Expand Down
9 changes: 7 additions & 2 deletions docs/index.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,19 @@
"[![image](https://img.shields.io/badge/YouTube-Channel-red)](https://www.youtube.com/c/QiushengWu)\n",
"[![image](https://img.shields.io/twitter/follow/giswqs?style=social)](https://twitter.com/giswqs)\n",
"\n",
"**A collection of Python packages for geosptial analysis and data visualization. Installing commonly used GeoPython packages with one single command.**\n",
"**A Python package for installing commonly used packages for geospatial analysis and data visualization with only one command.**\n",
"\n",
"- Free software: MIT license\n",
"- Documentation: https://geospatial.gishub.org\n",
"\n",
"## Disclaimer\n",
"\n",
"Currently, the `geospatial` package only helps you install commonly used packages for geospatial analysis and data visualization with only one command, making it easier to set up a conda environment for geospatial analysis and avoid dependency conflicts during installation. The `geospatial` package itself does not have any meaningful functions yet. After installation, you can continue to the commonly used geospatial packages as usual. \n",
"\n",
"\n",
"## Installation\n",
"\n",
"Install commonly used geospatial packages with one line of code.\n",
"Installing commonly used packages for geospatial analysis and data visualization with only one command.\n",
"\n",
"```\n",
"mamba install -c conda-forge geospatial\n",
Expand Down
8 changes: 5 additions & 3 deletions docs/usage.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# Usage

To use geospatial in a project:
Currently, the `geospatial` package only helps you install commonly used packages for geospatial analysis and data visualization with only one command, making it easier to set up a conda environment for geospatial analysis and avoid dependency conflicts during installation. The `geospatial` package itself does not have any meaningful functions yet. After installation, you can continue to the commonly used geospatial packages as usual. For example:

```
import geospatial
```python
import leafmap
m = leafmap.Map()
m
```
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
'Programming Language :: Python :: 3.8',
'Programming Language :: Python :: 3.9',
],
description="A Python package for geosptial analysis and data visualization.",
description="A Python package for installing commonly used packages for geospatial analysis and data visualization with only one command.",
install_requires=install_requires,
dependency_links=dependency_links,
license="MIT license",
Expand Down

0 comments on commit 170b433

Please sign in to comment.