SimpleSEDML 0.0.1__tar.gz

simplesedml-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 UW Sauro Lab
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

simplesedml-0.0.1/PKG-INFO

@@ -0,0 +1,92 @@
+Metadata-Version: 2.4
+Name: SimpleSEDML
+Version: 0.0.1
+Summary: Python Subnet Discovery for Systems Biology
+Author-email: Joseph Hellerstein <joseph.hellerstein@gmail.com>, Herbert S Sauro <hsauro@uw.edu>
+License: MIT License
+        
+        Copyright (c) 2025 UW Sauro Lab
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/sys-bio/SimpleSEDML
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: build
+Requires-Dist: coverage
+Requires-Dist: jupyterlab
+Requires-Dist: matplotlib
+Requires-Dist: nose2
+Requires-Dist: pandas
+Requires-Dist: phrasedml
+Requires-Dist: pip
+Requires-Dist: requests
+Requires-Dist: tabulate
+Requires-Dist: tellurium
+Requires-Dist: twine
+Requires-Dist: urllib3
+Dynamic: license-file
+
+[![Build](https://github.com/sys-bio/SimpleSEDML/actions/workflows/github-actions.yml/badge.svg)](https://github.com/sys-bio/SimpleSBML/actions/workflows/github-actions.yml)
+
+# SimpleSEDML
+A simple API for using the [Simulation Experiment Description Markup Language (SED-ML)](https://sed-ml.org/), a community standard for describing simulation experiments.
+
+The project provides a python interface to generating SED-ML based on the abstractions provided by [phraSED-ML](https://pmc.ncbi.nlm.nih.gov/articles/PMC5313123/pdf/nihms846540.pdf) to describe simulation experiments. These absractions are: (a) models (including changes in values of model parameters);
+(b) simulations (including deterministic, stochastic, and steady state);
+(c) tasks (which specify simulations to run on tasks and repetitions for changes in parameter values);
+and (d) output for data reports and plots.
+
+``SimpleSEDML`` generalizes the capabilities of ``PhraSEDML`` and simplifies its usage by exploiting the Python environment:
+
+* A model source can be a file path or URL and may be in the Antimony language as well as SBML;
+* Repeated tasks are defined more simply by the use of a ``pandas`` ``DataFrame``.
+* Convenience methods are provided to simplify the API.
+  
+# Example
+
+See this [Jupyter notebook](https://github.com/sys-bio/SimpleSEDML/blob/main/examples/usage_examples.ipynb) for a detailed example.
+
+Consider the model below in the Antimony language.
+
+    mymodel = """
+    model myModel
+        J1: S1 -> S2; k1*S1;
+        k1 = 0.5;
+    end
+    """
+
+We want to simulate this model and do a time course plot of all floating species in the model.
+
+    from simple_sedml import SimpleSEDML
+
+    sedml_str = SimpleSEDML.makeTimeCourse(mymodel)
+
+We can print, save, or execute ``sedml_str``. To execute it,
+
+    SimpleSEDML.executeSEDML(sedml_str)
+<img src="docs/images/phrasedml_example.png" style="width:300px;height:300px;">
+
+# Restrictions
+1. If there are multiple task directives and/or there is a repeated task directive AND there is a report directive, SimpleSEDML.execute only returns the results of the last simulation. You can circumvent this by iterating in python to obtain the desired reports.
+
+# Plans
+1. First implementation of ``SimpleSEDML`` with methods for ``addModel``, ``addSimulation``, ``addTask``, ``addReport``, ``execute``, and ``to_sedml``.

simplesedml-0.0.1/README.md

@@ -0,0 +1,45 @@
+[![Build](https://github.com/sys-bio/SimpleSEDML/actions/workflows/github-actions.yml/badge.svg)](https://github.com/sys-bio/SimpleSBML/actions/workflows/github-actions.yml)
+
+# SimpleSEDML
+A simple API for using the [Simulation Experiment Description Markup Language (SED-ML)](https://sed-ml.org/), a community standard for describing simulation experiments.
+
+The project provides a python interface to generating SED-ML based on the abstractions provided by [phraSED-ML](https://pmc.ncbi.nlm.nih.gov/articles/PMC5313123/pdf/nihms846540.pdf) to describe simulation experiments. These absractions are: (a) models (including changes in values of model parameters);
+(b) simulations (including deterministic, stochastic, and steady state);
+(c) tasks (which specify simulations to run on tasks and repetitions for changes in parameter values);
+and (d) output for data reports and plots.
+
+``SimpleSEDML`` generalizes the capabilities of ``PhraSEDML`` and simplifies its usage by exploiting the Python environment:
+
+* A model source can be a file path or URL and may be in the Antimony language as well as SBML;
+* Repeated tasks are defined more simply by the use of a ``pandas`` ``DataFrame``.
+* Convenience methods are provided to simplify the API.
+  
+# Example
+
+See this [Jupyter notebook](https://github.com/sys-bio/SimpleSEDML/blob/main/examples/usage_examples.ipynb) for a detailed example.
+
+Consider the model below in the Antimony language.
+
+    mymodel = """
+    model myModel
+        J1: S1 -> S2; k1*S1;
+        k1 = 0.5;
+    end
+    """
+
+We want to simulate this model and do a time course plot of all floating species in the model.
+
+    from simple_sedml import SimpleSEDML
+
+    sedml_str = SimpleSEDML.makeTimeCourse(mymodel)
+
+We can print, save, or execute ``sedml_str``. To execute it,
+
+    SimpleSEDML.executeSEDML(sedml_str)
+<img src="docs/images/phrasedml_example.png" style="width:300px;height:300px;">
+
+# Restrictions
+1. If there are multiple task directives and/or there is a repeated task directive AND there is a report directive, SimpleSEDML.execute only returns the results of the last simulation. You can circumvent this by iterating in python to obtain the desired reports.
+
+# Plans
+1. First implementation of ``SimpleSEDML`` with methods for ``addModel``, ``addSimulation``, ``addTask``, ``addReport``, ``execute``, and ``to_sedml``.

simplesedml-0.0.1/pyproject.toml

@@ -0,0 +1,35 @@
+[project]
+name = "SimpleSEDML"
+version = "0.0.1"
+description = "Python Subnet Discovery for Systems Biology"
+authors = [{ name = "Joseph Hellerstein", email = "joseph.hellerstein@gmail.com" }, {name = "Herbert S Sauro", email = "hsauro@uw.edu"}]
+license = { file = "LICENSE" }
+readme = "README.md"
+requires-python = ">=3.6"
+
+dependencies = [
+"numpy",
+"build",
+"coverage",
+"jupyterlab",
+"matplotlib",
+"nose2",
+"pandas",
+"phrasedml",
+"pip",
+"requests",
+"tabulate",
+"tellurium",
+"twine",
+"urllib3",
+]
+
+[project.urls]
+Homepage = 'https://github.com/sys-bio/SimpleSEDML'
+
+[options.package_data]
+data = "*.txt, *.csv, *.ant, *.xml"
+
+[build-system]
+requires = ["setuptools>=61.0.0", "wheel"]
+build-backend = "setuptools.build_meta"

simplesedml-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

simplesedml-0.0.1/src/SimpleSEDML.egg-info/PKG-INFO

@@ -0,0 +1,92 @@
+Metadata-Version: 2.4
+Name: SimpleSEDML
+Version: 0.0.1
+Summary: Python Subnet Discovery for Systems Biology
+Author-email: Joseph Hellerstein <joseph.hellerstein@gmail.com>, Herbert S Sauro <hsauro@uw.edu>
+License: MIT License
+        
+        Copyright (c) 2025 UW Sauro Lab
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/sys-bio/SimpleSEDML
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: build
+Requires-Dist: coverage
+Requires-Dist: jupyterlab
+Requires-Dist: matplotlib
+Requires-Dist: nose2
+Requires-Dist: pandas
+Requires-Dist: phrasedml
+Requires-Dist: pip
+Requires-Dist: requests
+Requires-Dist: tabulate
+Requires-Dist: tellurium
+Requires-Dist: twine
+Requires-Dist: urllib3
+Dynamic: license-file
+
+[![Build](https://github.com/sys-bio/SimpleSEDML/actions/workflows/github-actions.yml/badge.svg)](https://github.com/sys-bio/SimpleSBML/actions/workflows/github-actions.yml)
+
+# SimpleSEDML
+A simple API for using the [Simulation Experiment Description Markup Language (SED-ML)](https://sed-ml.org/), a community standard for describing simulation experiments.
+
+The project provides a python interface to generating SED-ML based on the abstractions provided by [phraSED-ML](https://pmc.ncbi.nlm.nih.gov/articles/PMC5313123/pdf/nihms846540.pdf) to describe simulation experiments. These absractions are: (a) models (including changes in values of model parameters);
+(b) simulations (including deterministic, stochastic, and steady state);
+(c) tasks (which specify simulations to run on tasks and repetitions for changes in parameter values);
+and (d) output for data reports and plots.
+
+``SimpleSEDML`` generalizes the capabilities of ``PhraSEDML`` and simplifies its usage by exploiting the Python environment:
+
+* A model source can be a file path or URL and may be in the Antimony language as well as SBML;
+* Repeated tasks are defined more simply by the use of a ``pandas`` ``DataFrame``.
+* Convenience methods are provided to simplify the API.
+  
+# Example
+
+See this [Jupyter notebook](https://github.com/sys-bio/SimpleSEDML/blob/main/examples/usage_examples.ipynb) for a detailed example.
+
+Consider the model below in the Antimony language.
+
+    mymodel = """
+    model myModel
+        J1: S1 -> S2; k1*S1;
+        k1 = 0.5;
+    end
+    """
+
+We want to simulate this model and do a time course plot of all floating species in the model.
+
+    from simple_sedml import SimpleSEDML
+
+    sedml_str = SimpleSEDML.makeTimeCourse(mymodel)
+
+We can print, save, or execute ``sedml_str``. To execute it,
+
+    SimpleSEDML.executeSEDML(sedml_str)
+<img src="docs/images/phrasedml_example.png" style="width:300px;height:300px;">
+
+# Restrictions
+1. If there are multiple task directives and/or there is a repeated task directive AND there is a report directive, SimpleSEDML.execute only returns the results of the last simulation. You can circumvent this by iterating in python to obtain the desired reports.
+
+# Plans
+1. First implementation of ``SimpleSEDML`` with methods for ``addModel``, ``addSimulation``, ``addTask``, ``addReport``, ``execute``, and ``to_sedml``.

simplesedml-0.0.1/src/SimpleSEDML.egg-info/SOURCES.txt

@@ -0,0 +1,22 @@
+LICENSE
+README.md
+pyproject.toml
+src/__init__.py
+src/constants.py
+src/model.py
+src/plot.py
+src/report.py
+src/simple_sedml.py
+src/simulation.py
+src/task.py
+src/SimpleSEDML.egg-info/PKG-INFO
+src/SimpleSEDML.egg-info/SOURCES.txt
+src/SimpleSEDML.egg-info/dependency_links.txt
+src/SimpleSEDML.egg-info/requires.txt
+src/SimpleSEDML.egg-info/top_level.txt
+tests/test_model.py
+tests/test_plot.py
+tests/test_report.py
+tests/test_simple_sedml.py
+tests/test_simulation.py
+tests/test_task.py

simplesedml-0.0.1/src/SimpleSEDML.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

simplesedml-0.0.1/src/SimpleSEDML.egg-info/requires.txt

@@ -0,0 +1,14 @@
+numpy
+build
+coverage
+jupyterlab
+matplotlib
+nose2
+pandas
+phrasedml
+pip
+requests
+tabulate
+tellurium
+twine
+urllib3

simplesedml-0.0.1/src/SimpleSEDML.egg-info/top_level.txt

@@ -0,0 +1,8 @@
+__init__
+constants
+model
+plot
+report
+simple_sedml
+simulation
+task

simplesedml-0.0.1/src/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.0.1"

simplesedml-0.0.1/src/constants.py

@@ -0,0 +1,4 @@
+import os
+
+PROJECT_DIR = os.path.dirname(os.path.dirname(__file__))
+TEST_DIR = os.path.join(PROJECT_DIR, "tests")

simplesedml-0.0.1/src/model.py

@@ -0,0 +1,188 @@
+'''Class that handles model definitions and their parameters.'''
+
+import codecs
+import urllib3
+import os
+import tellurium as te  # type: ignore
+from typing import Optional, List
+import warnings
+
+SBML_STR = "sbml_str"
+ANT_STR = "ant_str"
+SBML_FILE = "sbml_file"
+ANT_FILE = "ant_file"
+SBML_URL = "sbml_url"
+MODEL_ID = "model_id"
+MODEL_REF_TYPES = [SBML_STR, ANT_STR, SBML_FILE, ANT_FILE, SBML_URL, MODEL_ID]
+
+"""
+Issues
+1. To eliminate the warning for urllib3, need to create a virtual environment with a higher version of python.
+"""
+
+class Model:
+    def __init__(self, id:str, model_ref:Optional[str]=None, ref_type:Optional[str]=None, 
+                 model_source:Optional[str]=None, 
+                 is_overwrite:bool=False,
+                 **kwargs):
+        """Provide information about the model and a model identifier.
+
+        Args:
+            id (str): identifier for the model
+            model_ref (str): reference to the file; reference type is specified separately
+            ref_type (str):
+                - "sbml_str": string representation of the SBML model
+                - "ant_str": string representation of the SBML model
+                - "sbml_file": file path to the SBML model
+                - "ant_file": file path to the Antimony model
+                - "sbml_url": URL to the SBML model
+                - "model_id": ID of a previously defined model
+            is_overwrite (bool): if True, overwrite the model if it already exists
+            model_source (str): source for the SBML model. If None, the source is a file with the same name as the model ID
+                in the current directory.
+        """
+        # Handle defaults
+        if model_ref is None:
+            # id is a file path to an SBML model
+            model_ref = id
+            _, filename = os.path.split(id)
+            splits = filename.split(".")
+            id = splits[0]
+            ref_type = SBML_FILE
+        elif ref_type is None:
+            ref_type = SBML_STR
+        # id, model_ref, ref_type should all be assigned
+        self.id = id
+        self.model_ref = model_ref
+        self.ref_type = ref_type
+        self.param_change_dct = kwargs
+        self.is_overwrite = is_overwrite
+        #
+        self.sbml_str = self._getSBMLFromReference()
+        self.model_source_path = self._makeModelSource(model_source)
+
+    def _makeModelSource(self, source:Optional[str])->str:
+        """Saves the model to a file. The file name is the model ID.
+        """
+        if self.ref_type == MODEL_ID:
+            # model_ref is the ID of a previously defined model
+            return self.model_ref
+        # FIXME: Model source should be the filename in the path
+        if source is None:
+            # Use the current directory
+            source = os.getcwd()
+            source = os.path.join(source, self.id)
+        source = str(source)
+        if self.is_overwrite or not os.path.exists(source):
+            with open(source, "wb") as f:
+                f.write(self.sbml_str.encode('utf-8'))
+                f.flush()
+                print(f"**Model saved to {source}")
+        if (not self.is_overwrite and os.path.exists(source)):
+            msg = "*** File {model_source_path} already exists and will be used as model source."
+            msg += "\n  Use is_overwrite=True to overwrite."
+            warnings.warn(msg)
+        return source
+
+    def _getSBMLFromReference(self)->str:
+        """Extracts an SBML strong from the model reference
+
+        Args:
+            self.model_ref (str): reference to the file; reference type is specified separately
+            self.ref_type (str): One of self.MODEL_self.REF_TYPES
+
+        Returns:
+            SBML string
+        """
+        if self.ref_type in [SBML_FILE, ANT_FILE]:
+            with open(self.model_ref, "r") as f:
+                lines = f.read()
+            if self.ref_type == SBML_FILE:
+                sbml_str = lines
+            else:
+                sbml_str = te.antimonyToSBML(lines)
+        elif self.ref_type == SBML_STR:
+            sbml_str = self.model_ref
+        elif self.ref_type == ANT_STR:
+            sbml_str = te.antimonyToSBML(self.model_ref)
+        elif self.ref_type == MODEL_ID:
+            # self.model_ref is the ID of a previously defined model
+            sbml_str = "" 
+        else:
+            # self.ref_type == SBML_URL
+            response = urllib3.request("GET", self.model_ref)
+            if response.status == 200:
+                sbml_str = codecs.decode(response.data, 'utf-8')
+            else:
+                raise ValueError(f"Failed to fetch SBML from URL: {self.model_ref}")
+        return sbml_str
+
+    def __str__(self):
+        params = ", ".join(f"{param} = {val}" for param, val in self.param_change_dct.items())
+        if len(params) > 0:
+            params = f" with {params}"
+        if self.ref_type == MODEL_ID:
+            source = self.id
+        else:
+            source = f'"{self.model_source_path}"'
+        return f'{self.id} = model {source} {params}'
+
+    @staticmethod 
+    def findReferenceType(model_ref:str, model_ids:List[str], ref_type:Optional[str]=None)->str:
+        """Infers the reference type from the model reference.
+
+        Args:
+            model_ref (str): reference to the file; reference type is specified separately
+            model_ids (List[str]): List of known model IDs
+            refer_type (str): One of self.MODEL_REF_TYPES
+
+        Returns:
+            str: reference type
+        """
+        # Use the ref_type if it is specified
+        if ref_type is not None:
+            return ref_type
+        # Check if this is a model ID
+        if model_ref in model_ids:
+            try:
+                is_file = os.path.exists(model_ref)
+            except:
+                is_file = False
+            if is_file:
+                warnings.warn(f"Model ID {model_ref} is also a file path. Using model ID.")
+            return MODEL_ID
+        # Check for Antimony string
+        try:
+            _ = te.loada(model_ref)
+            return ANT_STR
+        except:
+            pass
+        # Check for SBML string
+        try:
+            _ = te.loadSBMLModel(model_ref)
+            if "sbml" in model_ref:
+                return SBML_STR
+        except:
+            pass
+        # Check if this is a URL
+        if ("http://" in model_ref) or ("https://" in model_ref):
+            return SBML_URL
+        # Check if this is a file path
+        try:
+            is_file = os.path.exists(model_ref)
+        except:
+            is_file = False
+        if is_file:
+            try:
+                with open(model_ref, "r") as f:
+                    lines = f.read()
+                if lines.startswith("<"):
+                    return SBML_FILE
+                else:
+                    return ANT_FILE
+            except:
+                pass
+        # Report error
+        msg = f"Unidentifiable model reference: {model_ref}. "
+        msg += f"\nFix the reference and/or specify the reference type.\nMust be one of {MODEL_REF_TYPES}."
+        raise ValueError(msg)

simplesedml-0.0.1/src/plot.py

@@ -0,0 +1,41 @@
+from typing import Optional, List, Union
+
+class Plot:
+    def __init__(self, x_var:str, y_var:Union[str, List[str]], z_var:Optional[str]=None, title:Optional[str]=None,
+                 is_plot:bool=True)->None:  
+        """
+        Plot class to represent a plot in the script. The following cases are supported:
+           plot x vs y (z is None, y is str)
+           plot x vs y1, y2, y3 (z is None, y is a list of str)
+           plot x vs y vs z  (z is a str, y is str)
+
+        Args:
+            x_var (str): x variable
+            y_var (str): y variable
+            z_var (str, optional): z variable. Defaults to None.
+            title (str, optional): title of the plot. Defaults to None.
+        """
+        self.x_var = x_var
+        self.y_var = y_var
+        self.z_var = z_var
+        self.title = title
+        self.is_plot = is_plot
+
+    # FIXME: Support the above use cases 
+    def __str__(self)->str:
+        if not self.is_plot:
+            return ""
+        if self.z_var is None:
+            if isinstance(self.y_var, str):
+                y_vars = [self.y_var]
+            else:
+                y_vars = self.y_var
+            var_clause = f'{self.x_var} vs {", ".join(y_vars)}'
+        else:
+            if not isinstance(self.y_var, str):
+                raise ValueError("y_var must be a string when z_var is provided")
+            var_clause = f"{self.x_var} vs {self.y_var} vs {self.z_var}"
+        if self.title is None:
+            return f"plot {var_clause}"
+        else:
+            return f"plot \"{self.title}\" {var_clause}"

simplesedml-0.0.1/src/report.py

@@ -0,0 +1,26 @@
+from typing import Optional
+
+class Report:
+    def __init__(self, metadata:Optional[dict]=None, title:str=""):
+        """Reports data after a simulation.
+
+        Args:
+            metadata (Optional[dict], optional): A dictionary of values saved in the
+                'attrs' attribute of the DataFrame generated.
+            title (str, optional): Saved in the SEDML
+        """
+        self.metadata = metadata
+        self.title = title
+        self.variables:list = []
+
+    def addVariables(self, *args):
+        """
+        List of data to report
+
+        Args:
+            *args: list of report variables
+        """
+        self.variables.extend(args)
+
+    def __str__(self)->str:
+        return "\n".join([f'report "{self.title}" {", ".join(self.variables)}'])