Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
C
caosdb-pylib
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Iterations
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container Registry
Model registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
caosdb
Software
caosdb-pylib
Commits
62f130d3
Unverified
Commit
62f130d3
authored
4 years ago
by
Daniel
Browse files
Options
Downloads
Patches
Plain Diff
DOC: Installation on Linux and Windows.
parent
29db5277
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
src/doc/getting_started.md
+23
-3
23 additions, 3 deletions
src/doc/getting_started.md
with
23 additions
and
3 deletions
src/doc/getting_started.md
+
23
−
3
View file @
62f130d3
...
...
@@ -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
)
.
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment