Merge pull request #150 from swiss-seismological-service/documentatio…

…n_branch_User_guide_Vanille

User guide documentation

README.md

@@ -37,13 +37,3 @@ pip install git+https://github.com/swiss-seismological-service/SeismoStats.git@f
 # update it once the repo has changed:
 pip install --force-reinstall git+https://github.com/swiss-seismological-service/SeismoStats.git
 ```
-
-## Problems with geos
-
-```
-1. geos_c.h not found
-Solutions (Mac):
-brew install geos
-Solutions:
-sudo apt-get libgeos-dev
-```

docs/source/index.md

@@ -7,7 +7,7 @@ API reference <reference/index>
 
 # Seismo Stats
 
-Measure your seismicity with **SeismoStats**, a Python package for seismicity analysis.
+Analyse your seismic catalogues with **SeismoStats**, a Python package for seismicity analysis.
 
 Check out the {doc}`user/usage` section for further information, or the {doc}`reference/index` for a technical reference.
 

docs/source/user/getting_started.md

@@ -0,0 +1,35 @@
+# Getting started
+
+`Seismostats` is a Python library but doesn't require extensive knowledge of Python. The statistical analysis of a catalog can be achieved easily without any coding expertise by following the step by step guide ({doc}`examples`).
+
+## Required packages and libraries
+
+We didn't reinvent the wheel and rely on existing libraries and packages to perform basic routines.
+
+### GEOS
+The plotting of the seismicity requires [GEOS](https://libgeos.org/), a C/C++ library for computational geometry. If `GEOS` is not installed on your machine, you will need to get it, for example on a linux machine with 
+```terminal
+sudo apt-get libgeos-dev
+```
+or on a mac with
+```terminal
+brew install geos
+```
+
+## Using SeismoStats in another code
+
+### Install from source
+This way of installing `SeismoStats` in another environement allows you to use the static version. 
+```terminal
+pip install git+https://github.com/swiss-seismological-service/SeismoStats.git
+```
+
+If you want to install a specific branch:
+```terminal
+pip install git+https://github.com/swiss-seismological-service/SeismoStats.git@feature/branch
+```
+
+To update your environment to the latest version of `SeismoStats`:
+```terminal
+pip install --force-reinstall git+https://github.com/swiss-seismological-service/SeismoStats.git
+```

docs/source/user/index.md

@@ -3,6 +3,8 @@
 ```{toctree}
 :maxdepth: 2
 
+what_is_seismostats
+getting_started
 usage
 docs
 ```

docs/source/user/what_is_seismostats.md

@@ -0,0 +1,5 @@
+# What is SeismoStats?
+
+SeismoStats is a python library for statistical analysis of seismicity. The library provides a {doc}`../reference/catalog` object, as well as routines to compute the statistical parameters as well as plot the seismicity catalogs and their statistical features.
+
+This library aims to provide a user friendly way to analyse seismic catalogs, with reliable and documented methods.