Skip to content
Snippets Groups Projects
Commit 4f91c5ca authored by florian's avatar florian
Browse files

DOC: Clean-up README_SETUP.md

parent 1c912d1c
No related branches found
No related tags found
1 merge request!22Release 0.3
Pipeline #15570 passed
This commit is part of merge request !22. Comments created here will be created in the context of that merge request.
...@@ -8,14 +8,16 @@ git clone 'https://gitlab.com/caosdb/caosdb-advanced-user-tools' ...@@ -8,14 +8,16 @@ git clone 'https://gitlab.com/caosdb/caosdb-advanced-user-tools'
``` ```
## Dependencies ## Dependencies
Dependencies will be installed automatically if you use the below described procedure. Dependencies will be installed automatically if you use the below described
- `caosdb>=0.4.0` procedure.
- `caosdb>=0.6.0`
- `openpyxl>=3.0.0` - `openpyxl>=3.0.0`
- `xlrd>=1.2.0` - `xlrd>=1.2.0`
- `pandas>=1.2.0` - `pandas>=1.2.0`
- `numpy>=1.17.3` - `numpy>=1.17.3`
If you want to use the optional h5-crawler the following dependencies will be installed additionally: If you want to use the optional h5-crawler the following dependencies will be
installed additionally:
- `h5py>=3.3.0` - `h5py>=3.3.0`
For testing: For testing:
...@@ -35,16 +37,15 @@ Optional h5-crawler: ...@@ -35,16 +37,15 @@ Optional h5-crawler:
## Run Integration Tests Locally ## Run Integration Tests Locally
1. Change directory to `integrationtests/`. 1. Change directory to `integrationtests/`.
2. Mount `extroot` to the folder that will be used as 2. Mount `extroot` to the folder that will be used as extroot. E.g. `sudo mount
extroot. E.g. `sudo mount -o bind extroot -o bind extroot ../../caosdb-deploy/profiles/empty/paths/extroot` (or
../../caosdb-deploy/profiles/empty/paths/extroot` (or whatever path whatever path the extroot of the empty profile to be used is located at).
the extroot of the empty profile to be used is located at). 3. Start (or restart) an empty (!) CaosDB instance (with the mounted
3. Start (or restart) an empty (!) CaosDB instance (with the mounted extroot). extroot). The database will be cleared during testing, so it's important to
The database will be cleared during testing, so it's important to use use an empty instance. Make sure your configuration for the python caosdb
an empty instance. module is correct and allows to connect to the server.
Make sure your configuration for the python caosdb module is correct and 4. Run `test.sh`. Note that this may modify content of the
allows to connect to the server. `integrationtest/extroot/` directory.
4. Run `test.sh`. Note that this may modify content of the `integrationtest/extroot/` directory.
## Code Formatting ## Code Formatting
`autopep8 -i -r ./` `autopep8 -i -r ./`
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment