Skip to content

Commit

Permalink
add ecosystem page
Browse files Browse the repository at this point in the history
  • Loading branch information
metelkin committed Dec 10, 2024
1 parent fae134c commit 8022526
Show file tree
Hide file tree
Showing 5 changed files with 62 additions and 46 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Any contribution is appreciated. Here we summarize how your can help.

## Tools and applications

List of supporting tools can be found on [implemented](implemented) page.
List of supporting tools can be found on [ecosystem](ecosystem) page.

- Use **Issues** and **Pull requests** in the particular repository.
- Let us know if the Heta project helps you to develop model or tool.
Expand Down
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

*An open-source initiative developing advanced tools and best practices for dynamic system modeling in pharmacology, PK/PD, QSP, and systems biology.*

- **About**
- [Ecosystem](ecosystem.md)
- [Version compatibility](compatibility.md)
- [Contributing](CONTRIBUTING.md)

---

## Empowering Modelers in Pharmacology and Systems Biology
Expand All @@ -14,7 +19,7 @@ The **Heta Project** is an open-source initiative dedicated to transforming the

- **Unified Data Structures:** Store model components, datasets, and tasks in a consistent format.
- **Domain-Specific Language:** Utilize the [Heta language](/specifications/), a DSL tailored for dynamic quantitative models.
- **Open-Source Tools and Resources:** Access [tools](implemented?id=Heta-supporting-tools), [examples](implemented?id=Open-source-QSP-platforms), and [study materials](resources/).
- **Open-Source Tools and Resources:** Access [tools](ecosystem?id=Heta-supporting-tools), [examples](ecosystem?id=Open-source-QSP-platforms), and [study materials](resources/).
- **Best Practices and Workflows:** Follow established methodologies for efficient model development.

---
Expand Down
5 changes: 2 additions & 3 deletions _sidebar.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
* [About](/)
* [Contributing](CONTRIBUTING.md)
* [Ecosystem](ecosystem.md)
* [Version compatibility](compatibility.md)
* [Implemented](implemented.md)
* [Recommended software](software.md)
* [Contributing](CONTRIBUTING.md)
74 changes: 53 additions & 21 deletions implemented.md → ecosystem.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,31 @@
# Implemented
# Ecosystem

## Heta supporting tools

- Julia package for simulation of large scale QSP models supporting Heta syntax: [HetaSimulator.jl](https://github.com/hetalang/HetaSimulator.jl) [![version](https://juliahub.com/docs/HetaSimulator/version.svg)](https://juliahub.com/ui/Packages/HetaSimulator/IIE0h)
- Command line tool compiling Heta and JS package: [heta-compiler](https://github.com/hetalang/heta-compiler) [![npm](https://img.shields.io/npm/v/heta-compiler)](https://www.npmjs.com/package/heta-compiler)
- Syntax highlighting for VSCode: [heta-highlight-vscode](https://github.com/hetalang/heta-highlight-vscode) [![Visual Studio Marketplace Version](https://img.shields.io/visual-studio-marketplace/v/insysbio.heta-highlight-vscode?label=VSMarket)](https://marketplace.visualstudio.com/items?itemName=insysbio.heta-highlight-vscode)
- Syntax highlighting for Sublime text: [heta-highlight-sublime](https://github.com/hetalang/heta-highlight-sublime) [![GitHub tag (with filter)](https://img.shields.io/github/v/tag/hetalang/heta-highlight-sublime)](https://packagecontrol.io/packages/heta)
- Parsing of Heta language code in JavaScript: [heta-parser](https://github.com/hetalang/heta-parser) [![npm](https://img.shields.io/npm/v/heta-parser)](https://www.npmjs.com/package/heta-parser)

## Web applications

Heta syntax and Heta infrastructure were utilized for the development of web-based tools.

- [Heta API](https://heta-api.insysbio.com/)
A public API for Heta language compilation.
- [Heta compiler online](https://heta-online.insysbio.com/)
Web based compiler and editor of Heta code.
- [SbmlViewer](https://sv.insysbio.com/)
A tool for fast and easy reading of biological models written in SBML format. It allows you to open SBML in any browser.
- [Immune Response Template](https://irt.insysbio.com)
A Quantitative Systems Pharmacology (QSP) platform of immune system and tool for development of QSP and mechanistic models related to immune response.
- [mAb-app](https://shiny.insysbio.com/mAb-app/)
PK/RO simulator for anti-PD-1 monoclonal Antibodies (Shiny app)
- [ery](https://shiny.insysbio.com/ery/)
PK/PD simulator for Erythropoiesis-Stimulating Agents (Shiny app)
- [sbml-mrgsolve-case](https://shiny.insysbio.com/sbml-mrgsolve-case/)
An RMarkdown example demonstrating format conversion from SBML into mrgsolve

## Open source QSP platforms

Expand All @@ -23,27 +50,32 @@ The examples of Heta-based QSP platforms with CI/CD capabilities are shared on G

The Heta language and Heta-based QSP framework were used in several “real world” projects for the development of middle-scale and large-scale models.

## Heta supporting tools
## Recommended Software for Working with Heta Models

- Julia package for simulation of large scale QSP models supporting Heta syntax: [HetaSimulator.jl](https://github.com/hetalang/HetaSimulator.jl) [![version](https://juliahub.com/docs/HetaSimulator/version.svg)](https://juliahub.com/ui/Packages/HetaSimulator/IIE0h)
- JavaScript framework and command line tool supporting Heta modules: [heta-compiler](https://github.com/hetalang/heta-compiler) [![npm](https://img.shields.io/npm/v/heta-compiler)](https://www.npmjs.com/package/heta-compiler)
- Syntax highlighting for VSCode: [heta-highlight-vscode](https://github.com/hetalang/heta-highlight-vscode) [![Visual Studio Marketplace Version](https://img.shields.io/visual-studio-marketplace/v/insysbio.heta-highlight-vscode?label=VSMarket)](https://marketplace.visualstudio.com/items?itemName=insysbio.heta-highlight-vscode)
- Syntax highlighting for Sublime text: [heta-highlight-sublime](https://github.com/hetalang/heta-highlight-sublime) [![GitHub tag (with filter)](https://img.shields.io/github/v/tag/hetalang/heta-highlight-sublime)](https://packagecontrol.io/packages/heta)
- Parsing of Heta language code in JavaScript: [heta-parser](https://github.com/hetalang/heta-parser) [![npm](https://img.shields.io/npm/v/heta-parser)](https://www.npmjs.com/package/heta-parser)
To get started with Heta-based platforms, we recommend installing a minimal set of tools for full functionality. This setup ensures an efficient workflow, especially for medium- to large-scale QSP platforms. Usage of an Integrated Development Environment (IDE) is optional but highly beneficial.

## Web applications
For a guided introduction, check out the Heta tutorial's [Lesson #1](https://youtu.be/aIpo9Yksyb8).

Heta syntax and Heta infrastructure were utilized for the development of web-based tools.
### Minimal Recommended Setup

- [Heta compiler online](https://heta-online.insysbio.com/)
Web based compiler and editor of Heta code.
- [SbmlViewer](https://sv.insysbio.com/)
A tool for fast and easy reading of biological models written in SBML format. It allows you to open SBML in any browser.
- [Immune Response Template](https://irt.insysbio.com)
A Quantitative Systems Pharmacology (QSP) platform of immune system and tool for development of QSP and mechanistic models related to immune response.
- [mAb-app](https://shiny.insysbio.com/mAb-app/)
PK/RO simulator for anti-PD-1 monoclonal Antibodies (Shiny app)
- [ery](https://shiny.insysbio.com/ery/)
PK/PD simulator for Erythropoiesis-Stimulating Agents (Shiny app)
- [sbml-mrgsolve-case](https://shiny.insysbio.com/sbml-mrgsolve-case/)
An RMarkdown example demonstrating format conversion from SBML into mrgsolve
1. **VSCode**
- Download and Install: [https://code.visualstudio.com/](https://code.visualstudio.com/)
- Install with extensions manager: [Heta Highlight Plugin](https://marketplace.visualstudio.com/items?itemName=heta-highlight)

2. **heta-compiler**
- Installation Guide: [https://hetalang.github.io/#/heta-compiler/?id=installation](https://hetalang.github.io/#/heta-compiler/?id=installation)

3. **HetaSimulator**
- Install Julia: [https://julialang.org/downloads/](https://julialang.org/downloads/)
- Install the package: [https://hetalang.github.io/#/HetaSimulator.jl/](https://hetalang.github.io/#/HetaSimulator.jl/)

4. **Git** *(optional)*
- Download: [https://git-scm.com/](https://git-scm.com/)
- Provides Bash console and Git synchronization for version control.

### Alternative Configuration

If you prefer, you can use **Sublime Text** instead of VSCode:
- Download and install: [https://www.sublimetext.com/download](https://www.sublimetext.com/download)
- Install the **Heta highlighter plugin** via:
- Open `Package Control` > `Install Package` > Search for `Heta`.
20 changes: 0 additions & 20 deletions software.md

This file was deleted.

0 comments on commit 8022526

Please sign in to comment.