| Name | btc2sim JSON |
| Version |
0.0.6
JSON |
| download |
| home_page | None |
| Summary | None |
| upload_time | 2024-10-30 08:45:17 |
| maintainer | None |
| docs_url | None |
| author | Noah Syrkis |
| requires_python | <3.12,>=3.11 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# c2sim
https://github.com/syrkis/c2sim/assets/25223901/11e8cf5e-230c-4245-9e68-d8825dd53965
This repository contains the source code for the C2SIM project. The C2SIM project is a simulation of a command and control system for a military organization. The project is written in `python3.11.7` with a heavy emphasis on functional programming and the JAX ecosystem. `notebook.ipynb` contains a Jupyter notebook that demonstrates the basic functionality of the project, while `main.py` contains the main entry point for the simulation. `src/` contains the source code for the project, including `smax.py` for functionts related the SMAX environment, `bt.py` for behavior tree (BT) related functions, `atomics.py` for atomic finctions for use in BTs, and `utils.py` for utility functions. The project also includes exstentive plotting functions located in `src/plot.py` for visualising SMAX trajectories and BTs.
## Installation
To install the project, clone the repository and install the dependencies using `pip` (probably a good idea to use a virtual environment):
```bash
git clone
cd c2sim
pip install -r requirements.txt
```
## Usage
You almost certainly want to start by running the Jupyter notebook:
```bash
jupyter lab
```
This will open a Jupyter notebook in your browser. Open `notebook.ipynb` and run the cells to see the basic functionality of the project. If you want to run simulations from the command line, you can do so with:
```bash
python main.py
```
## Behavior Trees
We are using a costum domain specific langauge (DSL) for behavior trees, the grammar of which is located in `grammar.lark`. The framework is implemented in `bt.py`, `bank.py`, and `atomics.py`.
Raw data
{
"_id": null,
"home_page": null,
"name": "btc2sim",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.12,>=3.11",
"maintainer_email": null,
"keywords": null,
"author": "Noah Syrkis",
"author_email": "noah@syrkis.com",
"download_url": "https://files.pythonhosted.org/packages/3f/bb/d84486d8dd12585b02aed15469d7ea361f08259d360033fe5e80b2811214/btc2sim-0.0.6.tar.gz",
"platform": null,
"description": "# c2sim\n\nhttps://github.com/syrkis/c2sim/assets/25223901/11e8cf5e-230c-4245-9e68-d8825dd53965\n\nThis repository contains the source code for the C2SIM project. The C2SIM project is a simulation of a command and control system for a military organization. The project is written in `python3.11.7` with a heavy emphasis on functional programming and the JAX ecosystem. `notebook.ipynb` contains a Jupyter notebook that demonstrates the basic functionality of the project, while `main.py` contains the main entry point for the simulation. `src/` contains the source code for the project, including `smax.py` for functionts related the SMAX environment, `bt.py` for behavior tree (BT) related functions, `atomics.py` for atomic finctions for use in BTs, and `utils.py` for utility functions. The project also includes exstentive plotting functions located in `src/plot.py` for visualising SMAX trajectories and BTs.\n\n## Installation\n\nTo install the project, clone the repository and install the dependencies using `pip` (probably a good idea to use a virtual environment):\n\n```bash\ngit clone\ncd c2sim\npip install -r requirements.txt\n```\n\n## Usage\n\nYou almost certainly want to start by running the Jupyter notebook:\n\n```bash\njupyter lab\n```\n\nThis will open a Jupyter notebook in your browser. Open `notebook.ipynb` and run the cells to see the basic functionality of the project. If you want to run simulations from the command line, you can do so with:\n\n```bash\npython main.py\n```\n\n\n## Behavior Trees\n\nWe are using a costum domain specific langauge (DSL) for behavior trees, the grammar of which is located in `grammar.lark`. The framework is implemented in `bt.py`, `bank.py`, and `atomics.py`.\n",
"bugtrack_url": null,
"license": null,
"summary": null,
"version": "0.0.6",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6dcac227d6a81bce93c4e7ef851855d580269e98e9ba3e3d1d7d91e967d84e8c",
"md5": "5fda7d387e2302bdddb238b70ee9a3b7",
"sha256": "830649006d06fe2db90f802cdb73211f1ba778543719700aaca895b60e46acdd"
},
"downloads": -1,
"filename": "btc2sim-0.0.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5fda7d387e2302bdddb238b70ee9a3b7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.12,>=3.11",
"size": 11468,
"upload_time": "2024-10-30T08:45:16",
"upload_time_iso_8601": "2024-10-30T08:45:16.416667Z",
"url": "https://files.pythonhosted.org/packages/6d/ca/c227d6a81bce93c4e7ef851855d580269e98e9ba3e3d1d7d91e967d84e8c/btc2sim-0.0.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3fbbd84486d8dd12585b02aed15469d7ea361f08259d360033fe5e80b2811214",
"md5": "abf1b0db103a41cebe4c4a14a62305d9",
"sha256": "ccb34f2e3d0fed3b256f85a0c36aba746decdc6f00574f350d1b68cef08b0dce"
},
"downloads": -1,
"filename": "btc2sim-0.0.6.tar.gz",
"has_sig": false,
"md5_digest": "abf1b0db103a41cebe4c4a14a62305d9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.12,>=3.11",
"size": 10230,
"upload_time": "2024-10-30T08:45:17",
"upload_time_iso_8601": "2024-10-30T08:45:17.738485Z",
"url": "https://files.pythonhosted.org/packages/3f/bb/d84486d8dd12585b02aed15469d7ea361f08259d360033fe5e80b2811214/btc2sim-0.0.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-30 08:45:17",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "btc2sim"
}
