Getting started¶
Installation¶
with PyPi and pip¶
We recommend to use pip to do a propper installation:
pip install geodezyx
To get the latest working version you can install directly the GitHub-hosted version:
pip install -I -U git+https://github.com/GeodeZYX/GeodeZYX-Toolbox_v4
clone and manually install from GitHub¶
You can manually fork and clone the GitHub repository https://github.com/GeodeZYX/GeodeZYX-Toolbox_v4/
and install the Toolbox you downloaded with python setup.py install
Alternatively, you can also add the geodezyx
forder in your PYTHONPATH
(for experimented users)
Minimal exemple¶
To test if the GeodeZYX Toolbox is well installed, import:
#### Import
from geodezyx import * # Import the GeodeZYX modules
from geodezyx.externlib import * # Import the external modules
from geodezyx.megalib.megalib import * # Import the legacy modules names
If the modules are well imported (without errors in the console), fine! you have the GeodeZYX Toolbox! If not, check again the potential errors during the installation.
Nevertheless, star imports are not recomended. It is better to import the modules separatelly, e.g.:
import geodezyx.conv as conv # Import the conversion module
See the description of each module in the following section
Description of the Modules¶
geodezyx.athmo
: functions implementing troposhere/ionosphere modelsgeodezyx.conv
: time and coordinates conversiongeodezyx.files_rw
: read, import & write geodetic filesgeodezyx.geodyn
: Euler pole calculator and plot velocity field mapsgeodezyx.marine
: contains a GEBCO bathymetry extrapolatorgeodezyx.operational
: Download GNSS data/products from various servers / Read and Import sitelogsgeodezyx.reffram
: Reference Frame & high-level coordinates conversiongeodezyx.stats
: Low-level statistics functions & outlier detection functions / Low-level least-square functionsgeodezyx.time_series
: module to handle Geodetic time-seriesgeodezyx.utils
: Shell-like functions (grep, find in folder …) and functions to optimize list management