diff --git a/src/doc/getting_started.md b/src/doc/getting_started.md index 68dcf6126acb0372f16f7b8e41bda97d5788bcd1..3af60d4c05027a3a0879aa2fea51b8d98c75fed8 100644 --- a/src/doc/getting_started.md +++ b/src/doc/getting_started.md @@ -13,6 +13,25 @@ typically be installed automatically): ### How to install ### +#### Linux #### + +Make sure that Python (at least version 3.6) and pip is installed, using your system tools and +documentation. + +Then open a terminal and continue in the [Generic installation](#generic-installation) section. + +#### Windows #### + +If a Python distribution is not yet installed, we recommend Anaconda Python, which you can download +for free from [https://www.anaconda.com](https://www.anaconda.com). The "Anaconda Individual Edition" provides most of all +packages you will ever need out of the box. If you prefer, you may also install the leaner +"Miniconda" installer, which allows you to install packages as you need them. + +After installation, open an Anaconda prompt from the Windows menu and continue in the [Generic +installation](#generic-installation) section. + +#### Generic installation #### + To install pycaosdb locally, use `pip3` (also called `pip` on some systems): ```sh @@ -21,7 +40,8 @@ pip3 install --user caosdb --- -Alternatively, obtain the sources from GitLab and install from there: +Alternatively, obtain the sources from GitLab and install from there (`git` must be installed for +this option): ```sh git clone https://gitlab.com/caosdb/caosdb-pylib @@ -38,7 +58,7 @@ Now, change the url and username fields as required. (Ask your CaosDB administra you do not know what to put there, but for demo instances like https://demo.indiscale.com, `admin` and `caosdb` often works). -More information about the configuration is available [in this documentation](configuration.html) as well. +More information about the configuration is available [in this documentation](configuration.md) as well. ## Try it out ## @@ -53,6 +73,6 @@ Out[2]: Connection to CaosDB with 501 Records. ``` Note: This setup will ask you for your password whenever a new connection is created. If you do not -like this, check out the "Authentication" section in the [configuration documentation](configuration.html). +like this, check out the "Authentication" section in the [configuration documentation](configuration.md). Now would be a good time to continue with the [tutorials](tutorials.html).