diff --git a/README.md b/README.md deleted file mode 100644 index 0c064c6..0000000 --- a/README.md +++ /dev/null @@ -1,14 +0,0 @@ -# tsupy - -Python binding for tsubasa Go. - -## Overview - -Package tsupy is a Python binding for the tsubasa Go library. - -## Install - -To install the package successfully, first install [gopy](https://github.com/go-python/gopy). Then, make sure you have the [netCDF C library](https://downloads.unidata.ucar.edu/netcdf/) is installed. - -To compile the package, run this inside tsupy directory: -`make build` diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..6cdd7a4 --- /dev/null +++ b/README.rst @@ -0,0 +1,46 @@ + +==================== +Tsupy +==================== + +.. image:: https://img.shields.io/pypi/pyversions/brainspace + :alt: PyPI - Python Version + + + +Tsupy is a toolbox primarily intended for dynamic network construction and analysis. It is a Python binding for the tsubasa Go library. + +Install +----------- + +To install the package successfully, first install `gopy `_. Then, make sure you have the `netCDF C library `_ is installed. + +To compile the package, run this inside tsupy directory: +`make build` + +Happy network analysis! + +License +----------- + +The Tsupy source code is available under the MIT license. + +Support +----------- + +If you have problems installing the software or questions about usage +and documentation, or something else related to Tsupy, +you can post to the Issues section of our `repository `_. + +Paper +----------- + +If you consider using Tsupy, please cite our manuscript: + + +Core development team +----------------------- + +* Jinshu Liu - University of Rochester +* Draco(Yunlong) Xu - University of Rochester +* Fatemeh Nargesian - University of Rochester