Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tomlue authored Nov 18, 2024
1 parent 7947cc4 commit 2f738c3
Showing 1 changed file with 2 additions and 35 deletions.
37 changes: 2 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,2 @@
# How to build bricks

1. Create a brick named `{newbrick}` from this template
```
gh repo create biobricks-ai/{newbrick} -p biobricks-ai/brick-template --public
gh repo clone biobricks-ai/{newbrick}
cd newbrick
```

2. Edit stages according to your needs:
Recommended scripts:
- ``01_download.sh``
- ``02_unzip.sh``
- ``03_build.sh`` calling a function to process individual files like ``csv2parquet.R`` or ``csv2parquet.py``

3. Replace stages in dvc.yaml with your new stages

4. Build your brick
```
dvc repro # runs new stages
```

5. Push the data to biobricks.ai
```
dvc push -r s3.biobricks.ai
```

6. Commit the brick
```
git add -A && git commit -m "some message"
git push
```

7. Monitor the bricktools github action

# pubchem-annotations-kg
Transforming [pubchem-annotations](https://github.com/biobricks-ai/pubchem-annotations-kg) into an HDT for [biobricks-okg](https://github.com/biobricks-ai/biobricks-okg)

0 comments on commit 2f738c3

Please sign in to comment.