Skip to content
Snippets Groups Projects
Commit 72133fef authored by Henrik tom Wörden's avatar Henrik tom Wörden
Browse files

DOC: unify the name PyCaosDB

parent be3d2eb0
No related branches found
No related tags found
No related merge requests found
# Getting started with pycaosdb #
# Getting started with PyCaosDB #
## Installation ##
### Requirements ###
Pycaosdb needs at least Python 3.6. Additionally, the following packages are required (they will
PyCaosDB needs at least Python 3.6. Additionally, the following packages are required (they will
typically be installed automatically):
- `lxml`
......@@ -32,7 +32,7 @@ installation](#generic-installation) section.
#### Generic installation ####
To install pycaosdb locally, use `pip3` (also called `pip` on some systems):
To install PyCaosDB locally, use `pip3` (also called `pip` on some systems):
```sh
pip3 install --user caosdb
......@@ -52,7 +52,7 @@ pip3 install --user .
## Configuration ##
The configuration is done using `ini` configuration files.
Pycaosdb tries to read from the inifile specified in the environment variable `PYCAOSDBINI` or
PyCaosDB tries to read from the inifile specified in the environment variable `PYCAOSDBINI` or
alternatively in `~/.pycaosdb.ini` upon import. After that, the ini file `pycaosdb.ini` in the
current working directory will be read additionally, if it exists.
......
========================
The concepts of pycaosdb
The concepts of PyCaosDB
========================
- `Configuration <configuration>`
......
# Configuration of pycaosdb #
The behavior of pycaosdb is defined via a configuration that is provided using configuration files.
Pycaosdb tries to read from the inifile specified in the environment variable `PYCAOSDBINI` or
# Configuration of PyCaosDB #
The behavior of PyCaosDB is defined via a configuration that is provided using configuration files.
PyCaosDB tries to read from the inifile specified in the environment variable `PYCAOSDBINI` or
alternatively in `~/.pycaosdb.ini` upon import. After that, the ini file `pycaosdb.ini` in the
current working directory will be read additionally, if it exists.
......
Welcome to pycaosdb's documentation!
Welcome to PyCaosDB's documentation!
====================================
.. toctree::
......@@ -13,7 +13,7 @@ Welcome to pycaosdb's documentation!
Configuration <configuration>
API documentation<_apidoc/modules>
This is the documentation for the Python client library for CaosDB, ``pycaosdb``.
This is the documentation for the Python client library for CaosDB, ``PyCaosDB``.
This documentation helps you to :doc:`get started<getting_started>`, explains the most important
:doc:`concepts<concepts>` and offers a range of :doc:`tutorials<tutorials>`.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment