update readme and docs for prereview

README.md

@@ -45,12 +45,23 @@ $ pip install -r ../pyshbundle/requirements-dev.txt
 $ source </location-of-virt-env/name-env/bin/activate>
 
 # install package into virtual environment
-$ pip install ../pyshbundle/dist/<required-version>.tzr.gz
+$ pip install ../pyshbundle/dist/<required-version>.tar.gz
 
 # you also have the option to build the module using, be careful of 
 $ python setup.py sdist
 ```
 
+## Trying it out
+
+Data for trying out this new tool is included in the repo. After installing and cloning the repo, go to the notebooks directory in order to find explainatory ipython jupyter notebooks. Simply activate the virtual environment and fire up these jupyter notebooks. Available notebooks:
+
+1. Introduction to Spherical Harmonics
+2. Loading the data
+3. Visualizations
+4. Terrestrial Water Storage (TWS) Time Series
+5. Tests and Validation notebook
+
+
 ## Read the Docs
 
 Please find the docs here - [PySHBundle](https://mn5hk.github.io/pyshbundle/)

docs/faq.md

@@ -1 +1,2 @@
 # FAQ
+Work in Progress...

docs/index.md

@@ -13,19 +13,24 @@
 
 
 ## How to install <br>
-We recommend using Mamba to install required packages <br>
-`conda create pysh` <br>
-`conda activate pysh` <br>
-`conda install -c conda-forge mamba` <br>
-`mamba install -c conda-forge numpy pandas netCDF4 scipy xarray julian scipy geopandas matplotlib rasterio salem shapely` <br>
+```shell
+# creating a new virtual environment
+$ python3 -m venv <name-env>
+# activate the virtual environment environment
+$ source </location-of-virt-env/name-env/bin/activate>
+# install package into virtual environment
+$ pip install pyshbundle
+
+# clone the repository in order to access the notebooks and data
+$ git clone [email protected]:mn5hk/pyshbundle.git
+```
+For more details refer to the installation section.
+
 
 Convert [SHbundle matlab codes](https://www.gis.uni-stuttgart.de/en/research/downloads/shbundle/) to python<br>
 [Geodesy for Earth system science (GESS) research Group at ICWaR, IISc](https://ultra-pluto-7f6d1.netlify.app/)
 ![](https://visitor-badge.glitch.me/badge?page_id=mn5hk.mat2py)
 
-Currently we are upgrading (under process) the package to be implementable on binder. 
-[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/mn5hk/pyshbundle/HEAD)
-
 
 ### Mathematics
 

docs/installation.md

@@ -4,20 +4,42 @@
 
 To install pyshbundle, run this command in your terminal:
 
-```
-pip install pyshbundle
-```
-
 This is the preferred method to install pyshbundle, as it will always install the most recent stable release.
 
 If you don't have [pip](https://pip.pypa.io) installed, this [Python installation guide](http://docs.python-guide.org/en/latest/starting/installation/) can guide you through the process.
 
-## From sources
+```shell
+# creating a new virtual environment
+$ python3 -m venv <name-env>
+# activate the virtual environment environment
+$ source </location-of-virt-env/name-env/bin/activate>
+# install package into virtual environment
+$ pip install pyshbundle
 
-The sources for pyshbundle can be downloaded from the Github repo.
+# clone the repository in order to access the notebooks and data
+$ git clone [email protected]:mn5hk/pyshbundle.git
+```
 
-You can clone the public repository:
+## From the source - for Devs/Contributors
 
-```
-git clone git://github.com/mn5hk/pyshbundle
+Developers can access the latest development branch and 
+
+```shell
+# clone the repo and fetch the dev branch
+$ git clone [email protected]:mn5hk/pyshbundle.git
+
+# creating a new virtual environment
+$ python3 -m venv <name-env>
+
+# install the dependencies from the requirements-dev file
+$ pip install -r ../pyshbundle/requirements-dev.txt
+
+# activate the virtual environment environment
+$ source </location-of-virt-env/name-env/bin/activate>
+
+# install package into virtual environment
+$ pip install ../pyshbundle/dist/<required-version>.tar.gz
+
+# you also have the option to build the module using, be careful of 
+$ python setup.py sdist
 ```

docs/usage.md

@@ -1,7 +1,10 @@
 # Usage
 
-To use pyshbundle in a project:
+In order to make getting started with PySHBundle simple, we have curated a set of introductory tutorials in form of jupyter notebooks. Data for trying out this new tool is included in the repo. After installing and cloning the repo, go to the notebooks directory in order to find explainatory ipython jupyter notebooks. Simply activate the virtual environment and fire up these jupyter notebooks. The following notebooks explain the usage of the tool aswell as some crucial basics of Spherical Harmonics processing for Grace.
+
+1. Introduction to Spherical Harmonics
+2. Loading the data
+3. Visualizations
+4. Terrestrial Water Storage (TWS) Time Series
+5. Tests and Validation notebook
 
-```
-import pyshbundle
-```