Skip to content

Commit 8bfca4f

Browse files
committed
Updated readme.md
1 parent cf3cf5f commit 8bfca4f

File tree

4 files changed

+85
-256
lines changed

4 files changed

+85
-256
lines changed

README.md

Lines changed: 28 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,33 @@
11
# ![GeodePy](https://github.com/GeoscienceAustralia/GeodePy/blob/master/docs/geodepy-logo.png)
22

3-
[![Travis](https://img.shields.io/travis/GeoscienceAustralia/GeodePy/master.svg?label=Travis%20CI)](https://travis-ci.org/GeoscienceAustralia/GeodePy) [![Coverage Status](https://coveralls.io/repos/github/GeoscienceAustralia/GeodePy/badge.svg)](https://coveralls.io/github/GeoscienceAustralia/GeodePy)
3+
GeodePy is a python package for precise geodetic and survey computations.
44

5-
This is a package of tools for manipulating geospatial datasets using Python and tested in Python 3.6.4.
6-
7-
### Documentation
5+
## Documentation
86

97
See [here](https://geodepy.readthedocs.io/) for documentation around downloading and using GeodePy.
108

11-
### Dependencies
9+
## Features
10+
11+
GeodePy includes a variety of features for geodesy and geospatial data manipulation, including:
12+
13+
* Converting between coordinate types
14+
* Transforming between datums
15+
* Calculating geodetic distances and bearings
16+
* Working with geoid models
17+
* Surveying calculations
18+
* Various classes for angles, coordinates, and datums
19+
* Statistics
20+
* And more!
21+
22+
## Installation
23+
24+
GeodePy is available on PyPi:
25+
26+
```console
27+
$ pip install geodepy
28+
```
29+
30+
## Dependencies
1231

1332
This package requires the following PyPI Packages installed:
1433

@@ -19,32 +38,21 @@ SciPy
1938

2039
Additionally, the geodepy.height module requires the GDAL library (tested using GDAL 3.0.4). For more information, see [here](https://gdal.org/index.html) for information about GDAL, [here](https://anaconda.org/conda-forge/gdal) for Anaconda support for GDAL and [here](http://www.gisinternals.com/release.php) for GDAL Binaries for Windows.
2140

22-
### Testing
41+
## Testing
2342

2443
Run: `python -m unittest discover geodepy/tests/ --verbose`
2544

26-
## API
27-
28-
```
29-
cd api/
30-
virtualenv env
31-
source env/bin/activate
32-
pip install -r requirements.txt
33-
zappa deploy dev
34-
```
35-
36-
For subsequent updating run: `zappa update dev`
37-
38-
### Authors
45+
## Authors
3946

4047
* **Craig Harrison** - *Project Management* - [harry093](https://github.com/harry093)
4148
* **Josh Batchelor** - *Initial Work, Geodesy and Surveying* - [BatchelorJ](https://github.com/BatchelorJ)
4249
* **Jonathan Mettes** - *Testing, Integration and Deployment* - [jmettes](https://github.com/jmettes)
4350
* **Jack McCubbine** - *Height Module* - [JackMcCubbineGA](https://github.com/JackMcCubbineGA)
51+
* **Kyran Cook** - *Documentation and Uplift* - [Kyran-Cook](https://github.com/Kyran-Cook)
4452

4553
See also the list of [contributors](https://github.com/GeoscienceAustralia/geodepy/graphs/contributors) who participated in this project.
4654

47-
### License
55+
## License
4856

4957
Copyright 2018-2020 Geoscience Australia
5058

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
# -- General configuration ---------------------------------------------------
2323
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
2424

25-
extensions = ["sphinx.ext.autodoc", "sphinx.ext.napoleon", "sphinx.ext.viewcode"]
25+
extensions = ["sphinx.ext.autodoc", "sphinx.ext.napoleon", "sphinx.ext.viewcode",'sphinx_copybutton']
2626

2727
templates_path = ['_templates']
2828
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']

0 commit comments

Comments
 (0)