Galaxy workflow converter: Difference between revisions

From BCOeditor Wiki
Jump to navigation Jump to search
 
(3 intermediate revisions by the same user not shown)
Line 7: Line 7:
# Install Validation Package:
# Install Validation Package:
## On the local terminal, clone the repository first by <code>git clone https://github.com/biocompute-objects/bcotool</code>
## On the local terminal, clone the repository first by <code>git clone https://github.com/biocompute-objects/bcotool</code>
## <code>cd bcotool/</code>
## Change directory: <code>cd bcotool/</code>
## <code>python -m venv env</code>
## Go to virtual environment: <code>python -m venv env</code>
## <code>. env/bin/activate</code>
## Activate virtual environment: <code>. env/bin/activate</code>
## <code>pip install -r requirements.txt</code>
## Install required packages: <code>pip install -r requirements.txt</code>
## <code>python bcotool/bco_runner.py validate -b [path to the converted file]</code> (Note: if only run <code>python bcotool/bco_runner.py</code>, more options can be seen.) If passed validation should show as the figure below [[File:Screen Shot 2022-11-09 at 16.38.10.png|800px|thumb|center]]
## Run validation: <code>python bcotool/bco_runner.py validate -b [path to the converted file]</code> (Note: if only run <code>python bcotool/bco_runner.py</code>, more options can be seen.) If passed validation should show as the figure below [[File:Screen Shot 2022-11-09 at 16.38.10.png|800px|thumb|center]]
## If they encountered errors, will show as the figure below: [[File:Screen Shot 2022-11-09 at 16.46.07.png|800px|thumb|center]]
## If they encountered errors, will show as the figure below: [[File:Screen Shot 2022-11-09 at 16.46.07.png|800px|thumb|center]]
##* Open error log for error description: <code>open error.log</code>
== Upload ==
# Converted JSON file can be uploaded to BCODB through copy/pasting the RAW JSON file directly on BCO Builder or through API, refer to API documentation [[BCO Portal Local Deployment|here]].

Latest revision as of 21:01, 10 November 2022

Workflows can be directly downloaded from Galaxy but file conversion is needed in order to transfer into BCODB successfully. Please follow the following steps to convert the file and validation:

File conversion

  1. Download the converter script from GitHub.
  2. On the local terminal, run the following command python [converter script's name.py] -b [path to the file that needs to be converted] -o [path to the output file]

Validation

  1. Install Validation Package:
    1. On the local terminal, clone the repository first by git clone https://github.com/biocompute-objects/bcotool
    2. Change directory: cd bcotool/
    3. Go to virtual environment: python -m venv env
    4. Activate virtual environment: . env/bin/activate
    5. Install required packages: pip install -r requirements.txt
    6. Run validation: python bcotool/bco_runner.py validate -b [path to the converted file] (Note: if only run python bcotool/bco_runner.py, more options can be seen.) If passed validation should show as the figure below
      Screen Shot 2022-11-09 at 16.38.10.png
    7. If they encountered errors, will show as the figure below:
      Screen Shot 2022-11-09 at 16.46.07.png
      • Open error log for error description: open error.log

Upload

  1. Converted JSON file can be uploaded to BCODB through copy/pasting the RAW JSON file directly on BCO Builder or through API, refer to API documentation here.