Skip to content
This repository has been archived by the owner on Jun 21, 2023. It is now read-only.

Commit

Permalink
Merge pull request #151 from SpiNNakerManchester/ds_rework
Browse files Browse the repository at this point in the history
Major cleanup/ reduction of the DataSpecification
  • Loading branch information
Christian-B committed Jun 20, 2023
2 parents d5a5141 + a4c6edd commit 4cc8254
Show file tree
Hide file tree
Showing 32 changed files with 25 additions and 7,811 deletions.
742 changes: 0 additions & 742 deletions DataSpecCommands.md

This file was deleted.

66 changes: 4 additions & 62 deletions data_specification/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,70 +13,12 @@
# limitations under the License.

"""
Used to generate memory images for a SpiNNaker CPU core from a set of
instructions.
The main part of this package is the
:py:class:`DataSpecificationGenerator`
class. This is used to generate a "Data Specification", which can then be
executed to produce a memory image. This package also handles this function
if required, through the
:py:class:`DataSpecificationExecutor` class.
Functional Requirements
=======================
Creation of a Data Specification Language file which can be executed to
produce a memory image.
* Any errors that can be checked during the creation of the specification
should throw an exception.
* It will be impossible to detect all errors at creation time.
* There should be no assumption of where the data specification will be
stored, although a default provision of a way to write the specification to
a file is acceptable.
Execution of a Data Specification Language file, producing a memory image.
* This should detect any errors during execution and report them, halting the
execution.
* There should be no assumption of where the data specification is read from,
although a default provision of a way to read the specification from a file
is acceptable.
Use Cases
=========
There are a number of use-cases of this library:
* :py:class:`DataSpecificationGenerator` is used to create a compressed memory
image which can be expanded later, to reduce the amount of data that needs
to be transferred over a slow connection.
* :py:class:`DataSpecificationExecutor` is used to execute a previously
generated specification at the receiving end of a slow connection.
Main API
========
Only use left is DataType
"""

from data_specification._version import (
__version__, __version_name__, __version_month__, __version_year__)
from .data_specification_executor import DataSpecificationExecutor
from .data_specification_executor_functions import (
DataSpecificationExecutorFunctions)
from .data_specification_generator import DataSpecificationGenerator
from .abstract_memory_region import AbstractMemoryRegion
from .memory_region_real import MemoryRegionReal
from .memory_region_reference import MemoryRegionReference
from .memory_region_collection import MemoryRegionCollection
from .reference_context import ReferenceContext

__all__ = [
"__version__", "__version_name__", "__version_month__", "__version_year__",
"DataSpecificationExecutor", "DataSpecificationExecutorFunctions",
"DataSpecificationGenerator", "AbstractMemoryRegion",
"MemoryRegionReal", "MemoryRegionReference",
"MemoryRegionCollection", "ReferenceContext"]
"__version__", "__version_name__", "__version_month__",
"__version_year__"]
19 changes: 0 additions & 19 deletions data_specification/abstract_memory_region.py

This file was deleted.

44 changes: 0 additions & 44 deletions data_specification/config_setup.py

This file was deleted.

81 changes: 0 additions & 81 deletions data_specification/constants.py

This file was deleted.

8 changes: 0 additions & 8 deletions data_specification/data_specification.cfg

This file was deleted.

0 comments on commit 4cc8254

Please sign in to comment.