Mercurial > repos > tduigou > sbol_converter

annotate README.md @ 1:529ee7dc1be9 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload commit a452ea11b96167cb1a683a1e9eea01a62840e547
author tduigou
date Tue, 18 Apr 2023 07:51:41 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
529ee7dc1be9 planemo upload commit a452ea11b96167cb1a683a1e9eea01a62840e547
tduigou
parents:
diff changeset
1 # sbol-converter -- Convert between SBOL3 and other genetic design formats.
529ee7dc1be9 planemo upload commit a452ea11b96167cb1a683a1e9eea01a62840e547
tduigou
parents:
diff changeset
2
529ee7dc1be9 planemo upload commit a452ea11b96167cb1a683a1e9eea01a62840e547
tduigou
parents:
diff changeset
3 The open-source software package sbol-converter is available here : https://github.com/SynBioDex/SBOL-utilities
529ee7dc1be9 planemo upload commit a452ea11b96167cb1a683a1e9eea01a62840e547
tduigou
parents:
diff changeset
4
529ee7dc1be9 planemo upload commit a452ea11b96167cb1a683a1e9eea01a62840e547
tduigou
parents:
diff changeset
5 ## How to run sbol-converter wrapper tests
529ee7dc1be9 planemo upload commit a452ea11b96167cb1a683a1e9eea01a62840e547
tduigou
parents:
diff changeset
6
529ee7dc1be9 planemo upload commit a452ea11b96167cb1a683a1e9eea01a62840e547
tduigou
parents:
diff changeset
7 In order to execute tests on sbol-converter wrapper, you need to:
529ee7dc1be9 planemo upload commit a452ea11b96167cb1a683a1e9eea01a62840e547
tduigou
parents:
diff changeset
8
529ee7dc1be9 planemo upload commit a452ea11b96167cb1a683a1e9eea01a62840e547
tduigou
parents:
diff changeset
9 - Connect to your galaxy instance in interactive mode:
529ee7dc1be9 planemo upload commit a452ea11b96167cb1a683a1e9eea01a62840e547
tduigou
parents:
diff changeset
10
529ee7dc1be9 planemo upload commit a452ea11b96167cb1a683a1e9eea01a62840e547
tduigou
parents:
diff changeset
11 ```bash
529ee7dc1be9 planemo upload commit a452ea11b96167cb1a683a1e9eea01a62840e547
tduigou
parents:
diff changeset
12 docker exec -it -u root galaxy_galaxy_1 bash
529ee7dc1be9 planemo upload commit a452ea11b96167cb1a683a1e9eea01a62840e547
tduigou
parents:
diff changeset
13 ```
529ee7dc1be9 planemo upload commit a452ea11b96167cb1a683a1e9eea01a62840e547
tduigou
parents:
diff changeset
14 - Copy all the contents of `test-data` folder into your own test-data directory which is located in your local galaxy instance : `/galaxy/test-data`. It contains all the input files and expected output files needed for the tests.
529ee7dc1be9 planemo upload commit a452ea11b96167cb1a683a1e9eea01a62840e547
tduigou
parents:
diff changeset
15
529ee7dc1be9 planemo upload commit a452ea11b96167cb1a683a1e9eea01a62840e547
tduigou
parents:
diff changeset
16 - Install Planemo:
529ee7dc1be9 planemo upload commit a452ea11b96167cb1a683a1e9eea01a62840e547
tduigou
parents:
diff changeset
17 You can see here the documentation for Planemo Installation : https://planemo.readthedocs.io/en/latest/installation.html
529ee7dc1be9 planemo upload commit a452ea11b96167cb1a683a1e9eea01a62840e547
tduigou
parents:
diff changeset
18 Note that they recommand to install Planemo by setting up a virtual environment:
529ee7dc1be9 planemo upload commit a452ea11b96167cb1a683a1e9eea01a62840e547
tduigou
parents:
diff changeset
19
529ee7dc1be9 planemo upload commit a452ea11b96167cb1a683a1e9eea01a62840e547
tduigou
parents:
diff changeset
20 ```bash
529ee7dc1be9 planemo upload commit a452ea11b96167cb1a683a1e9eea01a62840e547
tduigou
parents:
diff changeset
21 python3 -m venv planemo
529ee7dc1be9 planemo upload commit a452ea11b96167cb1a683a1e9eea01a62840e547
tduigou
parents:
diff changeset
22 . planemo/bin/activate
529ee7dc1be9 planemo upload commit a452ea11b96167cb1a683a1e9eea01a62840e547
tduigou
parents:
diff changeset
23 pip install -U planemo
529ee7dc1be9 planemo upload commit a452ea11b96167cb1a683a1e9eea01a62840e547
tduigou
parents:
diff changeset
24 ```
529ee7dc1be9 planemo upload commit a452ea11b96167cb1a683a1e9eea01a62840e547
tduigou
parents:
diff changeset
25
529ee7dc1be9 planemo upload commit a452ea11b96167cb1a683a1e9eea01a62840e547
tduigou
parents:
diff changeset
26 - run the tests:
529ee7dc1be9 planemo upload commit a452ea11b96167cb1a683a1e9eea01a62840e547
tduigou
parents:
diff changeset
27
529ee7dc1be9 planemo upload commit a452ea11b96167cb1a683a1e9eea01a62840e547
tduigou
parents:
diff changeset
28 ```bash
529ee7dc1be9 planemo upload commit a452ea11b96167cb1a683a1e9eea01a62840e547
tduigou
parents:
diff changeset
29 planemo test --conda_channels conda-forge,bioconda --conda_debug tools/synbiocad-galaxy-wrappers/sbol-converter/wrap.xml
529ee7dc1be9 planemo upload commit a452ea11b96167cb1a683a1e9eea01a62840e547
tduigou
parents:
diff changeset
30 ```
529ee7dc1be9 planemo upload commit a452ea11b96167cb1a683a1e9eea01a62840e547
tduigou
parents:
diff changeset
31
529ee7dc1be9 planemo upload commit a452ea11b96167cb1a683a1e9eea01a62840e547
tduigou
parents:
diff changeset
32 You can also specify your data test directory with the following option: `--test_data DIRECTORY_DATA_TEST`
529ee7dc1be9 planemo upload commit a452ea11b96167cb1a683a1e9eea01a62840e547
tduigou
parents:
diff changeset
33
529ee7dc1be9 planemo upload commit a452ea11b96167cb1a683a1e9eea01a62840e547
tduigou
parents:
diff changeset
34 IMPORTANT: Maybe you will need to remove CONDA from your PATH for the command `planemo test` to run correctly. To do that, you can edit this file `~/.bashrc`, comment this line `PATH="/root/anaconda3/bin:$PATH"` and save changes.
529ee7dc1be9 planemo upload commit a452ea11b96167cb1a683a1e9eea01a62840e547
tduigou
parents:
diff changeset
35
529ee7dc1be9 planemo upload commit a452ea11b96167cb1a683a1e9eea01a62840e547
tduigou
parents:
diff changeset
36 Planemo will output an html test summary `tool_test_output.html`.