Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/master'
Browse files Browse the repository at this point in the history
  • Loading branch information
JoshLoecker committed Aug 29, 2023
2 parents d60e520 + 2899a36 commit 452184a
Show file tree
Hide file tree
Showing 46 changed files with 1,137 additions and 99,901 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/continuous_delivery.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ jobs:
id: buildx
uses: docker/setup-buildx-action@v2

- name: Clearn Jupyter Notebook Outputs
- name: Clean Jupyter Notebook Outputs
uses: actions/setup-python@v4
with:
python-version: "3.10"
Expand Down
5 changes: 4 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,8 @@
/docs/Gemfile.lock

/main/logs/
/main/data/results
/main/data/results/
/main/data/config_sheets/*_data_inputs_auto.xlsx
/main/data/gene_info.csv
/main/data/Repurposing_Hub_Preproc.tsv
/main/microarray.db
26 changes: 19 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,25 @@
# COMO: Constraint-based Optimizations of Metabolic Objectives
# COMO: Constraint-based Optimization of Metabolic Objectives

[![Unit Tests](https://github.com/HelikarLab/COMO/actions/workflows/unit_tests.yml/badge.svg)](https://github.com/HelikarLab/COMO/actions/workflows/unit_tests.yml)
[![Documentation](https://github.com/HelikarLab/COMO/actions/workflows/pages/pages-build-deployment/badge.svg?branch=master)](https://github.com/HelikarLab/COMO/actions/workflows/pages/pages-build-deployment)

This is the home page for the COMO pipeline.
## Docker Quick Start

[Create and view Issues](https://github.com/HelikarLab/COMO/issues)
This installation method **does** require docker

## Quick Start
- [Install Docker](https://docs.docker.com/get-docker/)
- Pull our latest container
- `docker pull ghcr.io/helikarlab/como:latest`
- Run the container
- `docker run -p 8888:8888 ghcr.io/helikarlab/como:latest`

> **NOTE**: The defualt installation method here does not allow for saving your work or utilizing
> the [Gurobi solver](https://www.gurobi.com/). If you would like either (or both) of these features,
> please [visit our documentation](https://helikarlab.github.io/COMO) for more details
## Conda Quick Start

This installation method does **not** require docker

- [Install Conda](https://conda.io/projects/conda/en/latest/user-guide/install/index.html)
- Preferably, [install mamba](https://mamba.readthedocs.io/en/latest/mamba-installation.html#mamba-install) instead.
Expand All @@ -32,9 +44,9 @@ This is the home page for the COMO pipeline.
This will open a web browser with the Jupyter Notebook/Lab interface. From here, you can open the `COMO.ipynb` notebook
to get started

## Detailed Start

For more detailed information, please [view our documentation](https://helikarlab.github.io/COMO)
> **NOTE**: This installation method allows for saving your work and utilizing
> the [Gurobi solver](https://www.gurobi.com/). If you would still like more details about this installation method,
> please [visit our documentation](https://helikarlab.github.io/COMO)
## Flow Charts

Expand Down
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
176 changes: 111 additions & 65 deletions docs/_data/sidebars/como_sidebar.yml
Original file line number Diff line number Diff line change
@@ -1,87 +1,133 @@
# This is your sidebar TOC. The sidebar code loops through sections here and provides the appropriate formatting.

entries:
- title: sidebar
product:
version:

folders:
- title:
output: pdf
type: frontmatter
folderitems:
- title:
url: /titlepage.html
output: pdf
type: frontmatter
- title:
url: /tocpage.html
output: pdf
type: frontmatter

- title: Overview
output: web, pdf
folderitems:

- title: Getting Started
url: /index.html
- title: sidebar
product:
version:

folders:
- title:
output: pdf
type: frontmatter
folderitems:
- title:
url: /titlepage.html
output: pdf
type: frontmatter
- title:
url: /tocpage.html
output: pdf
type: frontmatter

- title: Overview
output: web, pdf
type: homepage
folderitems:

- title: Example Workflow
url: /como_example_workflow.html
output: web, pdf
- title: Getting Started
url: /index.html
output: web, pdf
type: homepage

- title: Flow Charts
url: /como_flowcharts.html
output: web, pdf
- title: Example Workflow
url: /como_example_workflow.html
output: web, pdf

- title: Resources
url: /como_resources.html
output: web, pdf
- title: Flow Charts
url: /como_flowcharts.html
output: web, pdf

- title: Resources
url: /como_resources.html
output: web, pdf

- title: Repository Structure
url: /como_repository_structure.html
- title: Docker Installation Method
output: web, pdf
folderitems:
- title: Overview
url: /como_docker_overview.html
output: web, pdf

- title: Arguments
output: web
folderitems:
- title: Installing Docker
url: /como_docker_installation.html
output: web, pdf

- title: Pulling the Container
url: /como_docker_pull_container.html
output: web, pdf

- title: Obtaining a Gurobi License
url: /como_docker_gurobi_license.html
output: web, pdf

- title: Arguments Overview
url: /como_arguments_overview.html
- title: Starting the Container
url: /como_docker_start_container.html
output: web, pdf

- title: Conda Installation Method
output: web, pdf
folderitems:
- title: Overview
url: /como_conda_overview.html
output: web, pdf

subfolders:
- title: Python Arguments
url: /como_python_arguments.html
- title: Conda/Mamba Installation
url: /como_conda_installation.html
output: web, pdf
subfolderitems:

- title: Create Context Specific Model
url: /como_args_create_context_specific_model.html
output: web, pdf
- title: Clone COMO Repository
url: /como_clone_repository.html
output: web, pdf

- title: Disease Analysis
url: /como_args_disease_analysis.html
output: web, pdf
- title: Install Dependencies
url: /como_install_dependencies.html
output: web, pdf

- title: Knockout Simulation
url: /como_args_knockout_simulation.html
output: web, pdf
- title: Obtaining a Gurobi License
url: /como_conda_gurobi_license.html
output: web, pdf

- title: Merge Omics
url: /como_args_merge_xomics.html
output: web, pdf
- title: Start COMO
url: /como_start_notebook.html
output: web, pdf

- title: Proteomics Gen
url: /como_args_proteomics_gen.html
output: web, pdf
- title: API Arguments
output: web
folderitems:

- title: RNA Seq Gen
url: /como_args_rnaseq_gen.html
output: web, pdf
- title: Arguments Overview
url: /como_arguments_overview.html
output: web, pdf

- title: RNA Seq Preprocess
url: /como_args_rnaseq_preprocess.html
subfolders:
- title: Python Arguments
url: /como_python_arguments.html
output: web, pdf
subfolderitems:

- title: Create Context Specific Model
url: /como_args_create_context_specific_model.html
output: web, pdf

- title: Disease Analysis
url: /como_args_disease_analysis.html
output: web, pdf

- title: Knockout Simulation
url: /como_args_knockout_simulation.html
output: web, pdf

- title: Merge Omics
url: /como_args_merge_xomics.html
output: web, pdf

- title: Proteomics Gen
url: /como_args_proteomics_gen.html
output: web, pdf

- title: RNA Seq Gen
url: /como_args_rnaseq_gen.html
output: web, pdf

- title: RNA Seq Preprocess
url: /como_args_rnaseq_preprocess.html
output: web, pdf
10 changes: 4 additions & 6 deletions docs/_data/topnav.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
## Topnav single links
## if you want to list an external url, use external_url instead of url. the theme will apply a different link base.
topnav:
- title: Topnav
items:
- title: News
url: /news
- title: GitHub
external_url: https://github.com/HelikarLab/COMO
- title: Topnav
items:
- title: GitHub
external_url: https://github.com/HelikarLab/COMO
20 changes: 11 additions & 9 deletions docs/_includes/feedback.html
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
<li>
{% if site.feedback_text %}
{% if site.feedback_text %}
{% assign feedback_text = site.feedback_text %}
{% else %}
{% else %}
{% assign feedback_text = "Feedback" %}
{% endif %}

{% if site.feedback_link %}
<a class="email" title="Submit feedback" href="{{site.feedback_link}}">{{feedback_text}}</a>
{% else %}
<a class="email" title="Submit feedback" href="#" onclick="javascript:window.location='mailto:{{site.feedback_email}}?subject={{site.feedback_subject_line}} feedback&body=I have some feedback about the {{page.title}} page: ' + window.location.href;"><i class="fa fa-envelope-o"></i> {{feedback_text}}</a>
{% endif %}
{% endif %}

{% if site.feedback_link %}
<a class="email" title="Submit feedback" href="{{site.feedback_link}}" target="_blank">{{feedback_text}}</a>
{% else %}
<a class="email" title="Submit feedback" href="#"
onclick="javascript:window.location='mailto:{{site.feedback_email}}?subject={{site.feedback_subject_line}} feedback&body=I have some feedback about the {{page.title}} page: ' + window.location.href;"><i
class="fa fa-envelope-o"></i> {{feedback_text}}</a>
{% endif %}
</li>

{% comment %} Copyright 2021 Google LLC {% endcomment %}
6 changes: 4 additions & 2 deletions docs/_includes/footer.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,10 @@
<div class="col-lg-12 footer">
<a href="https://github.com/HelikarLab/COMO">COMO</a> is maintained by <a href="https://github.com/JoshLoecker">Josh Loecker</a> and <a href="https://github.com/babessell1">Brandt Bessell</a><br>
&copy;{{ site.time | date: "%Y" }} {{site.company_name}}. All rights reserved. <br />
{% if page.last_updated %}<span>Page last updated:</span> {{page.last_updated}}<br/>{% endif %} Site last generated: {{ site.time | date: "%b %-d, %Y" }} <br />
<p><img src="{{ "images/helikarlab_nobackground.png" }}" alt="Company logo"/></p>
{% if page.last_updated %}<span>Page last updated:</span> {{page.last_updated}}<br/>{% endif %}
Site last generated: {{ site.time | date: "%b %-d, %Y" }} <br />
Theme modified from <a href="https://idratherbewriting.com/documentation-theme-jekyll/" target="_blank">idratherbewriting.com</a>
<p><img src="{{ "images/helikarlab_nobackground.png" }}" alt="Company logo"/></p>
</div>
</div>
</footer>
Expand Down
Loading

0 comments on commit 452184a

Please sign in to comment.