Skip to content

Commit

Permalink
add CI
Browse files Browse the repository at this point in the history
  • Loading branch information
cdiener committed Jan 28, 2021
1 parent 0463e91 commit 1f868b6
Show file tree
Hide file tree
Showing 4 changed files with 50 additions and 2 deletions.
27 changes: 27 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
on:
push:
# Sequence of patterns matched against refs/tags
tags:
- 'v[0-9]+.[0-9]+.0' # Push events to matching v*, i.e. v1.0, v20.15.10

name: Create Minor Release

jobs:
build:
name: Create Release
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v2
- name: Create Release
id: create_release
uses: actions/create-release@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token
with:
tag_name: ${{ github.ref }}
release_name: Release ${{ github.ref }}
body: |
Please see https://github.com/micom-dev/micom/blob/master/NEWS.md for the full release notes.
draft: false
prerelease: false
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -127,3 +127,6 @@ dmypy.json

# Pyre type checker
.pyre/

# specific
data/*.qza
12 changes: 12 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
## News and release notes for MICOM media

This includes a list of major changes for each minor version.

For information on how to use `MICOM` please see the docs at
https://micom-dev.github.io/micom.

### 1.0.0

Initial release that includes western diet gut media for AGORA and CARVEME.

Add instructions on how to contribute.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Environmental growth media for MICOM :seedline: :earth_africa: :pizza:

This repo contains recipes and artifacts for growth media with use in MICOM. Community contributions are very much welcome and invited :smile:
This repo contains recipes and artifacts for growth media with use in MICOM. Community contributions are very much welcome and invited :smile:

## How to add a new recipe/medium

Expand Down Expand Up @@ -36,14 +36,19 @@ Run all steps in the notebook and save it. Then add a new entry in the `Availabl
---

*Short description of the medium*

[recipe](recipes/my_recipe.ipynb) | [medium](https://raw.githubusercontent.com/micom-dev/media/main/media/my_recipe.qza)

Longer description of the growth medium.
```

Finally create a pull request on this repository which will make your medium for addition into
the repo.

## Available media

**Western diet medium for the human gut (AGORA)**

[recipe](recipes/agora.ipynb) | [medium](https://raw.githubusercontent.com/micom-dev/media/main/media/agora.qza)

This is a growth medium representing the likely distribution of available nutrients in the lower intesting under
Expand All @@ -53,10 +58,11 @@ absorbed in the small intestine were diluted 1:10. The medium is adapted to the
---

**Western diet medium for the human gut (AGORA)**

[recipe](recipes/carveme.ipynb) | [medium](https://raw.githubusercontent.com/micom-dev/media/main/media/agora.qza)

This is a growth medium representing the likely distribution of available nutrients in the lower intesting under
an average European diet. The medium was taken from https://doi.org/10.1038/nbt.4212 and components commonly
absorbed in the small intestine were diluted 1:10. Only components that could be mapped to the CARVEME DB were kept
and the medium was completed to allow growth for all 1.8K+ genera in the database. The medium is adapted to the CARVEME
reconstructions using Refseq v84.
reconstructions using Refseq v84.

0 comments on commit 1f868b6

Please sign in to comment.