diff --git a/README.md b/README.md index 7a71dce88afed5b7ac1c1222f954ac5265290cd8..b58368e6caa6a8e907892f987c168fbbc674ca84 100644 --- a/README.md +++ b/README.md @@ -41,23 +41,38 @@ python3 -m pip install --user --upgrade setuptools ### Installing -First, clone `the repository <https://gitlab.irstea.fr/telquel-obs2co/insitu/trios>`__ and execute the following command in the +First, clone `the repository`(<https://gitlab.irstea.fr/telquel-obs2co/insitu/trios>) and execute the following command in the local copy: -:: +``` +python3 setup.py install +``` - $ python setup.py install +This will install the package into the system's Python path. +If you have not the administrator rights, you can install the package as follows: -This will install the package into the system's Python path. If another -destination directory is preferred, it can be set by +``` +python3 setup.py install --user +``` -:: +If another destination directory is preferred, it can be set by - $ python setup.py install --prefix=<where-to-install> +``` +python3 setup.py install --prefix=<where-to-install> +``` This installation is supposed to download and compile all the associated packages as well as prepare the executables `trios_processing` and `trios_visual`. +If the installation is successful, you should have: +``` +$ trios_processing +Usage: + trios_processing <input_dir> <IDpr> <measurement_type> --lat <lat> --lon <lon> [--altitude=alt] [--ofile <ofile>] [--odir <odir>] [--plot] [--figdir <figdir>] [--name <name>] [--method <method>] [--no_clobber] + trios_processing -h | --help + trios_processing -v | --version +``` + ## Running the tests ```