# Agents Assembly Translator
## Table of Contents
- [About](#about)
- [Agents Assembly](#agents-assembly)
- [Getting Started](#getting-started)
- [Structure](#structure)
- [Contributing](#contributing)
## About <a name = "about"></a>
A target agnostic translator for Agents Assembly. The translator can be tested live on [Agents Assembly website](https://agents-assembly.com/translator).
It is a part of the [Agents Assembly](https://agents-assembly.com) ecosystem.
Other applications are:
- [Local Interface](https://github.com/agent-based-information-flow-simulation/local-interface) - GUI for simulation definition, management, and analysis.
- [Simulation Run Environment](https://github.com/agent-based-information-flow-simulation/simulation-run-environment) - environment for running scalable agent-based simulations.
- [Communication Server](https://github.com/agent-based-information-flow-simulation/communication-server) - cluster of servers used for XMPP communication.
- [Local Development Environment](https://github.com/agent-based-information-flow-simulation/local-development-environment) - simple environment for running agent-based simulations.
## Agents Assembly <a name = "agents-assembly"></a>
Documentation of Agents Assembly can be read [here](DOCS.md).
## Getting Started <a name = "getting-started"></a>
### Prerequisites
```
Python 3.10
```
### Installation
The translator [package](https://pypi.org/project/aasm) can be installed by running:
```
pip install aasm
```
Alternatively, you can download this repository. No additional dependencies are required.
### Usage
You can run the translator as a package. To translate *agent.aasm* to SPADE, run:
```
python -m aasm.translate agent.aasm
```
For more usage information, run:
```
python -m aasm.translate --help
```
## Structure <a name = "structure"></a>
* `generating`
* `code.py` - generated code
* `python_code.py` - Python code base class
* `python_graph.py` - Python graph code generation from the intermediate representation
* `python_spade.py` - SPADE agent code generation from the intermediate representation
* `intermediate`
* `action.py`
* `agent.py`
* `argument.py` - arguments used in instructions
* `behaviour.py`
* `block.py` - block of code representation
* `declaration.py` - declarations used in actions
* `graph.py`
* `instruction.py` - instructions used in actions
* `message.py`
* `parsing`
* `parse.py` - parsing environment from Agents Assembly file
* `op/` - Agents Assembly operations
* `state.py` - state definition used for the parsing process
* `preprocessor`
* `constants.py` - constants used in the preprocessor
* `macro.py` - macro definitions used in the preprocessor
* `preprocessor_item.py` - preprocessor base item
* `preprocessor.py`
* `utils`
* `exception.py`
* `validation.py`
* `iteration.py`
* `translate.py` - entrypoint
## Contributing <a name = "contributing"></a>
Please follow the [contributing guide](CONTRIBUTING.md) if you wish to contribute to the project.
Raw data
{
"_id": null,
"home_page": null,
"name": "aasm",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "aasm,agents assembly,agents,translator,dsl,domain specific language,simulations",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/14/16/6d2063c640b216348e34a624402116e52ab336f2269a30c0669d4a136703/aasm-0.1.9.tar.gz",
"platform": null,
"description": "# Agents Assembly Translator\n\n## Table of Contents\n\n- [About](#about)\n- [Agents Assembly](#agents-assembly)\n- [Getting Started](#getting-started)\n- [Structure](#structure)\n- [Contributing](#contributing)\n\n## About <a name = \"about\"></a>\nA target agnostic translator for Agents Assembly. The translator can be tested live on [Agents Assembly website](https://agents-assembly.com/translator).\nIt is a part of the [Agents Assembly](https://agents-assembly.com) ecosystem.\nOther applications are:\n- [Local Interface](https://github.com/agent-based-information-flow-simulation/local-interface) - GUI for simulation definition, management, and analysis.\n- [Simulation Run Environment](https://github.com/agent-based-information-flow-simulation/simulation-run-environment) - environment for running scalable agent-based simulations.\n- [Communication Server](https://github.com/agent-based-information-flow-simulation/communication-server) - cluster of servers used for XMPP communication.\n- [Local Development Environment](https://github.com/agent-based-information-flow-simulation/local-development-environment) - simple environment for running agent-based simulations.\n\n## Agents Assembly <a name = \"agents-assembly\"></a>\nDocumentation of Agents Assembly can be read [here](DOCS.md).\n\n## Getting Started <a name = \"getting-started\"></a>\n\n### Prerequisites\n\n```\nPython 3.10\n```\n\n### Installation\nThe translator [package](https://pypi.org/project/aasm) can be installed by running:\n```\npip install aasm\n```\nAlternatively, you can download this repository. No additional dependencies are required.\n\n### Usage\nYou can run the translator as a package. To translate *agent.aasm* to SPADE, run:\n```\npython -m aasm.translate agent.aasm\n```\n\nFor more usage information, run:\n```\npython -m aasm.translate --help\n```\n\n## Structure <a name = \"structure\"></a>\n\n* `generating`\n * `code.py` - generated code\n * `python_code.py` - Python code base class\n * `python_graph.py` - Python graph code generation from the intermediate representation\n * `python_spade.py` - SPADE agent code generation from the intermediate representation\n* `intermediate`\n * `action.py`\n * `agent.py`\n * `argument.py` - arguments used in instructions\n * `behaviour.py`\n * `block.py` - block of code representation\n * `declaration.py` - declarations used in actions\n * `graph.py`\n * `instruction.py` - instructions used in actions\n * `message.py`\n* `parsing`\n * `parse.py` - parsing environment from Agents Assembly file\n * `op/` - Agents Assembly operations\n * `state.py` - state definition used for the parsing process\n* `preprocessor`\n * `constants.py` - constants used in the preprocessor\n * `macro.py` - macro definitions used in the preprocessor\n * `preprocessor_item.py` - preprocessor base item\n * `preprocessor.py`\n* `utils`\n * `exception.py`\n * `validation.py`\n * `iteration.py`\n* `translate.py` - entrypoint\n\n## Contributing <a name = \"contributing\"></a>\nPlease follow the [contributing guide](CONTRIBUTING.md) if you wish to contribute to the project.\n",
"bugtrack_url": null,
"license": null,
"summary": "Agents Assembly translator",
"version": "0.1.9",
"project_urls": {
"Documentation": "https://agents-assembly.com/docs",
"Source": "https://github.com/agent-based-information-flow-simulation/agents-assembly-translator"
},
"split_keywords": [
"aasm",
"agents assembly",
"agents",
"translator",
"dsl",
"domain specific language",
"simulations"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "71ca2617bf2493edfb70b0fcb6cca888c661e770dca21653df734a8b8ff66759",
"md5": "aab1d044b639e5d854b9edb0dd947a6d",
"sha256": "f59b74cdf1daedd816be821f62c652195e09172187664697bd698775dd977fbc"
},
"downloads": -1,
"filename": "aasm-0.1.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "aab1d044b639e5d854b9edb0dd947a6d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 70429,
"upload_time": "2023-09-05T15:58:05",
"upload_time_iso_8601": "2023-09-05T15:58:05.038959Z",
"url": "https://files.pythonhosted.org/packages/71/ca/2617bf2493edfb70b0fcb6cca888c661e770dca21653df734a8b8ff66759/aasm-0.1.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "14166d2063c640b216348e34a624402116e52ab336f2269a30c0669d4a136703",
"md5": "4f1fa9da4ccbd6b83db92f0a35b79e6d",
"sha256": "a2c981c3f17600849b005f4f8d2dc2a2a94bce404233925643793aadc2f3026c"
},
"downloads": -1,
"filename": "aasm-0.1.9.tar.gz",
"has_sig": false,
"md5_digest": "4f1fa9da4ccbd6b83db92f0a35b79e6d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 84730,
"upload_time": "2023-09-05T15:58:09",
"upload_time_iso_8601": "2023-09-05T15:58:09.956178Z",
"url": "https://files.pythonhosted.org/packages/14/16/6d2063c640b216348e34a624402116e52ab336f2269a30c0669d4a136703/aasm-0.1.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-05 15:58:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "agent-based-information-flow-simulation",
"github_project": "agents-assembly-translator",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "aasm"
}
JSON
