Skip to content

Commit

Permalink
first commit
Browse files Browse the repository at this point in the history
  • Loading branch information
pmendes committed Oct 30, 2024
1 parent b5abe47 commit b43d988
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions UserManual.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# User manual for *sbmodelr* - a tool to replicate one SBML/COPASI model into a set of replicas

## Summary
*sbmodelr* takes as input an SBML or COPASI file describing a model. It then creates a new model that replicates the original in several copies ('units') where each one may interact with other ones. The topology of the connections can be arbitrary (described in a DOT network file), a 2D rectangular matrix, or a 3D cuboid array.

## Examples
The rest of this document describes the many options that are available in *sbmodelr*, but specific examples of usage are provided in the `examples` folder, which illustrate real-world usage of this tool, mostly replicating existing modeling papers. The examples are:

- Cells in a medium
- Row of cells with gap junctions
- Array of oscillating cells
- Neuron networks I: small(ish) networks using a Hodgkin-Huxley-type model
- Neuron networks II: large networks using the Izhikevich model
- Gene regulatory networks: easy creation of large (or small) gene networks from a simple model file

## Usage



## Saved text
If the original was an SBML model the output will automatically be another SBML model, if it was a COPASI model then the output will be another COPASI model; note that in this case the script attempts to adapt the Tasks to use the new model. It is also possible to input one format and output the other through commmand line options.

0 comments on commit b43d988

Please # to comment.