Update README and requirements.txt: add companion code section and update numpy version
Browse files- README.md +4 -0
- requirements.txt +2 -1
README.md
CHANGED
|
@@ -22,6 +22,7 @@ This dataset is designed for **regime-aware time-series modeling**, **systems bi
|
|
| 22 |
| Model source | SBML (`.xml`) |
|
| 23 |
| Extra metadata | Initial conditions + regime annotations |
|
| 24 |
| Global index | `SysBio-Traj_index.csv` |
|
|
|
|
| 25 |
| Simulation backend | Tellurium |
|
| 26 |
| Model ID format | `BIOMD...` or `MODEL...` |
|
| 27 |
|
|
@@ -61,6 +62,7 @@ Each model folder contains exactly four files:
|
|
| 61 |
1. Start with **`SysBio-Traj_index.csv`** to find the `model_id`, `model_name`, and simulation time range.
|
| 62 |
2. Open **`Data/<model_id>/`** to access the trajectory, SBML file, and metadata for that model.
|
| 63 |
3. Use **`scripts/simulate_sbml.py`** if you want to reproduce a trajectory from the released SBML + initial conditions.
|
|
|
|
| 64 |
|
| 65 |
### `SysBio-Traj_index.csv`
|
| 66 |
|
|
@@ -104,6 +106,8 @@ Install the required Python packages:
|
|
| 104 |
pip install -r requirements.txt
|
| 105 |
```
|
| 106 |
|
|
|
|
|
|
|
| 107 |
Example:
|
| 108 |
|
| 109 |
```bash
|
|
|
|
| 22 |
| Model source | SBML (`.xml`) |
|
| 23 |
| Extra metadata | Initial conditions + regime annotations |
|
| 24 |
| Global index | `SysBio-Traj_index.csv` |
|
| 25 |
+
| Companion code | [RegimeFlow](https://github.com/zhaoxixixi/RegimeFlow) |
|
| 26 |
| Simulation backend | Tellurium |
|
| 27 |
| Model ID format | `BIOMD...` or `MODEL...` |
|
| 28 |
|
|
|
|
| 62 |
1. Start with **`SysBio-Traj_index.csv`** to find the `model_id`, `model_name`, and simulation time range.
|
| 63 |
2. Open **`Data/<model_id>/`** to access the trajectory, SBML file, and metadata for that model.
|
| 64 |
3. Use **`scripts/simulate_sbml.py`** if you want to reproduce a trajectory from the released SBML + initial conditions.
|
| 65 |
+
4. Use the companion [RegimeFlow repository](https://github.com/zhaoxixixi/RegimeFlow) for the model training and evaluation workflow built around this dataset.
|
| 66 |
|
| 67 |
### `SysBio-Traj_index.csv`
|
| 68 |
|
|
|
|
| 106 |
pip install -r requirements.txt
|
| 107 |
```
|
| 108 |
|
| 109 |
+
The pinned environment is intended for Python 3.10. Tellurium and libRoadRunner may not provide compatible wheels for newer Python releases.
|
| 110 |
+
|
| 111 |
Example:
|
| 112 |
|
| 113 |
```bash
|
requirements.txt
CHANGED
|
@@ -1,3 +1,4 @@
|
|
| 1 |
-
numpy==2.
|
| 2 |
pandas==2.3.3
|
|
|
|
| 3 |
tellurium==2.2.13
|
|
|
|
| 1 |
+
numpy==2.2.6
|
| 2 |
pandas==2.3.3
|
| 3 |
+
libroadrunner==2.8.0
|
| 4 |
tellurium==2.2.13
|