| Name | trafficSimulator JSON |
| Version |
0.0.1
JSON |
| download |
| home_page | |
| Summary | A microscopic traffic simulation in Python |
| upload_time | 2023-04-07 22:54:12 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.7 |
| license | MIT License Copyright (c) 2023 Bilal Himite 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. |
| keywords |
traffic
setuptools
development
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<!-- Improved compatibility of back to top link: See: https://github.com/othneildrew/Best-README-Template/pull/73 -->
<a name="readme-top"></a>
<!-- PROJECT SHIELDS -->
<!--
*** I'm using markdown "reference style" links for readability.
*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
*** See the bottom of this document for the declaration of the reference variables
*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
-->
<div align="center">
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]
</div>
<!-- PROJECT LOGO -->
<br />
<div align="center">
<h3 align="center">trafficSimulator</h3>
<p align="center">
A microscopic traffic simulator in Python.
</p>
</div>
<!-- ABOUT THE PROJECT -->
## About The Project
[![trafficSimulator screenshot][product-screenshot]](https://example.com)
**trafficSimulator** is a Python project that aims to provide a flexible and user-friendly platform for creating and testing traffic scenarios and analyzing their outcomes.
**trafficSimulator** is suitable for students, researchers and practitioners who are interested in studying traffic phenomena and finding solutions for traffic problems.
To learn more about how the project was created check out this [article](https://towardsdatascience.com/simulating-traffic-flow-in-python-ee1eab4dd20f) on Medium.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
### Built With
* [![Python][Python]][Python-url]
* [![Numpy][Numpy]][Numpy-url]
* [![Scipy][Scipy]][Scipy-url]
* [![Dear PyGui][DearPyGui]][DearPyGui-url]
### Based on:
* Treiber, Martin; Hennecke, Ansgar; Helbing, Dirk (2000),<br>"**Congested traffic states in empirical observations and microscopic simulations**", Physical Review E, 62 (2): 1805–1824, [arXiv:cond-mat/0002177](https://arxiv.org/abs/cond-mat/0002177), [Bibcode:2000PhRvE..62.1805T](https://ui.adsabs.harvard.edu/abs/2000PhRvE..62.1805T), [doi:10.1103/PhysRevE.62.1805](https://doi.org/10.1103%2FPhysRevE.62.1805), [PMID 11088643](https://pubmed.ncbi.nlm.nih.gov/11088643), [S2CID 1100293](https://api.semanticscholar.org/CorpusID:1100293)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- GETTING STARTED -->
## Getting Started
### Prerequisites
Requires Python 3.7+.
### Installation
#### Using PIP
```sh
pip install trafficSimulator
```
#### Installing from source
1. `git clone https://github.com/BilHim/trafficSimulator`
2. `cd trafficSimulator`
3. `pip install -e .`
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- USAGE EXAMPLES -->
## Usage
You can import the module using:
```python
import trafficSimulator as ts
```
_For more examples, please refer to the [Examples](https://github.com/BilHim/trafficSimulator/tree/main/examples) folder._
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- DOCUMENTATION -->
## Documentation
To be completed.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- ROADMAP -->
## Roadmap
To be completed.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- CONTRIBUTING -->
## Contributing
Check out the [Contribution Guidelines](https://github.com/BilHim/trafficSimulator/blob/main/CONTRIBUTING.md).
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LICENSE -->
## License
Distributed under the MIT License. See [`LICENSE`](https://github.com/BilHim/trafficSimulator/blob/main/LICENSE) for more information.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- CONTACT -->
## Contact
Bilal Himite
* LinkedIn: [@bilalhimite][linkedin-url]
* Medium: [@bilhim](https://medium.com/@bilhim)
* Email: mail.bilalhimite@gmail.com
Project Link: [https://github.com/BilHim/trafficSimulator](https://github.com/BilHim/trafficSimulator)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
[contributors-shield]: https://img.shields.io/github/contributors/BilHim/trafficSimulator.svg?style=for-the-badge
[contributors-url]: https://github.com/BilHim/trafficSimulator/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/BilHim/trafficSimulator.svg?style=for-the-badge
[forks-url]: https://github.com/BilHim/trafficSimulator/forks
[stars-shield]: https://img.shields.io/github/stars/BilHim/trafficSimulator.svg?style=for-the-badge
[stars-url]: https://github.com/BilHim/trafficSimulator/stargazers
[issues-shield]: https://img.shields.io/github/issues/BilHim/trafficSimulator.svg?style=for-the-badge
[issues-url]: https://github.com/othneildrew/Best-README-Template/issues
[license-shield]: https://img.shields.io/github/license/BilHim/trafficSimulator.svg?style=for-the-badge
[license-url]: https://github.com/BilHim/trafficSimulator/blob/master/LICENSE
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://www.linkedin.com/in/bilalhimite/
[product-screenshot]: images/screenshot-1.png
[Python]: https://img.shields.io/badge/python-306998?style=for-the-badge&logo=python&logoColor=white
[Python-url]: https://www.python.org/
[Numpy]: https://img.shields.io/badge/numpy-4b73c9?style=for-the-badge&logo=numpy&logoColor=white
[Numpy-url]: https://numpy.org/
[Scipy]: https://img.shields.io/badge/scipy-0054a6?style=for-the-badge&logo=scipy&logoColor=white
[Scipy-url]: https://scipy.org/
[DearPyGui]: https://img.shields.io/badge/DearPyGUI-306998?style=for-the-badge
[DearPyGui-url]: https://github.com/hoffstadt/DearPyGui
Raw data
{
"_id": null,
"home_page": "",
"name": "trafficSimulator",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "traffic,setuptools,development",
"author": "",
"author_email": "Bilal Himite <mail.bilalhimite@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/14/e6/81974d14a360c11e501ad0f37eb1471f622520b895c6ba7a84f466995702/trafficSimulator-0.0.1.tar.gz",
"platform": null,
"description": "<!-- Improved compatibility of back to top link: See: https://github.com/othneildrew/Best-README-Template/pull/73 -->\r\n<a name=\"readme-top\"></a>\r\n\r\n<!-- PROJECT SHIELDS -->\r\n<!--\r\n*** I'm using markdown \"reference style\" links for readability.\r\n*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).\r\n*** See the bottom of this document for the declaration of the reference variables\r\n*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.\r\n*** https://www.markdownguide.org/basic-syntax/#reference-style-links\r\n-->\r\n\r\n<div align=\"center\">\r\n\r\n[![Contributors][contributors-shield]][contributors-url]\r\n[![Forks][forks-shield]][forks-url]\r\n[![Stargazers][stars-shield]][stars-url]\r\n[![Issues][issues-shield]][issues-url]\r\n[![MIT License][license-shield]][license-url]\r\n[![LinkedIn][linkedin-shield]][linkedin-url]\r\n\r\n</div>\r\n\r\n\r\n<!-- PROJECT LOGO -->\r\n<br />\r\n<div align=\"center\">\r\n <h3 align=\"center\">trafficSimulator</h3>\r\n\r\n <p align=\"center\">\r\n A microscopic traffic simulator in Python.\r\n </p>\r\n</div>\r\n\r\n\r\n\r\n<!-- ABOUT THE PROJECT -->\r\n## About The Project\r\n\r\n[![trafficSimulator screenshot][product-screenshot]](https://example.com)\r\n\r\n**trafficSimulator** is a Python project that aims to provide a flexible and user-friendly platform for creating and testing traffic scenarios and analyzing their outcomes.\r\n\r\n**trafficSimulator** is suitable for students, researchers and practitioners who are interested in studying traffic phenomena and finding solutions for traffic problems.\r\n\r\nTo learn more about how the project was created check out this [article](https://towardsdatascience.com/simulating-traffic-flow-in-python-ee1eab4dd20f) on Medium.\r\n\r\n<p align=\"right\">(<a href=\"#readme-top\">back to top</a>)</p>\r\n\r\n\r\n\r\n### Built With\r\n\r\n* [![Python][Python]][Python-url]\r\n* [![Numpy][Numpy]][Numpy-url]\r\n* [![Scipy][Scipy]][Scipy-url]\r\n* [![Dear PyGui][DearPyGui]][DearPyGui-url]\r\n\r\n### Based on:\r\n* Treiber, Martin; Hennecke, Ansgar; Helbing, Dirk (2000),<br>\"**Congested traffic states in empirical observations and microscopic simulations**\", Physical Review E, 62 (2): 1805\u20131824, [arXiv:cond-mat/0002177](https://arxiv.org/abs/cond-mat/0002177), [Bibcode:2000PhRvE..62.1805T](https://ui.adsabs.harvard.edu/abs/2000PhRvE..62.1805T), [doi:10.1103/PhysRevE.62.1805](https://doi.org/10.1103%2FPhysRevE.62.1805), [PMID 11088643](https://pubmed.ncbi.nlm.nih.gov/11088643), [S2CID 1100293](https://api.semanticscholar.org/CorpusID:1100293)\r\n\r\n<p align=\"right\">(<a href=\"#readme-top\">back to top</a>)</p>\r\n\r\n\r\n\r\n<!-- GETTING STARTED -->\r\n## Getting Started\r\n\r\n### Prerequisites\r\n\r\nRequires Python 3.7+.\r\n\r\n### Installation\r\n\r\n#### Using PIP\r\n```sh\r\npip install trafficSimulator\r\n```\r\n\r\n#### Installing from source\r\n1. `git clone https://github.com/BilHim/trafficSimulator`\r\n2. `cd trafficSimulator`\r\n3. `pip install -e .`\r\n\r\n<p align=\"right\">(<a href=\"#readme-top\">back to top</a>)</p>\r\n\r\n\r\n\r\n<!-- USAGE EXAMPLES -->\r\n## Usage\r\n\r\nYou can import the module using:\r\n```python\r\nimport trafficSimulator as ts\r\n```\r\n\r\n_For more examples, please refer to the [Examples](https://github.com/BilHim/trafficSimulator/tree/main/examples) folder._\r\n\r\n<p align=\"right\">(<a href=\"#readme-top\">back to top</a>)</p>\r\n\r\n<!-- DOCUMENTATION -->\r\n## Documentation\r\n\r\nTo be completed.\r\n\r\n<p align=\"right\">(<a href=\"#readme-top\">back to top</a>)</p>\r\n\r\n<!-- ROADMAP -->\r\n## Roadmap\r\n\r\nTo be completed.\r\n\r\n<p align=\"right\">(<a href=\"#readme-top\">back to top</a>)</p>\r\n\r\n\r\n\r\n<!-- CONTRIBUTING -->\r\n## Contributing\r\n\r\nCheck out the [Contribution Guidelines](https://github.com/BilHim/trafficSimulator/blob/main/CONTRIBUTING.md).\r\n\r\nIf you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag \"enhancement\".\r\nDon't forget to give the project a star! Thanks again!\r\n\r\n1. Fork the Project\r\n2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)\r\n3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)\r\n4. Push to the Branch (`git push origin feature/AmazingFeature`)\r\n5. Open a Pull Request\r\n\r\n<p align=\"right\">(<a href=\"#readme-top\">back to top</a>)</p>\r\n\r\n\r\n\r\n<!-- LICENSE -->\r\n## License\r\n\r\nDistributed under the MIT License. See [`LICENSE`](https://github.com/BilHim/trafficSimulator/blob/main/LICENSE) for more information.\r\n\r\n<p align=\"right\">(<a href=\"#readme-top\">back to top</a>)</p>\r\n\r\n\r\n\r\n<!-- CONTACT -->\r\n## Contact\r\n\r\nBilal Himite\r\n* LinkedIn: [@bilalhimite][linkedin-url]\r\n* Medium: [@bilhim](https://medium.com/@bilhim)\r\n* Email: mail.bilalhimite@gmail.com\r\n\r\nProject Link: [https://github.com/BilHim/trafficSimulator](https://github.com/BilHim/trafficSimulator)\r\n\r\n<p align=\"right\">(<a href=\"#readme-top\">back to top</a>)</p>\r\n\r\n\r\n<!-- MARKDOWN LINKS & IMAGES -->\r\n<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->\r\n[contributors-shield]: https://img.shields.io/github/contributors/BilHim/trafficSimulator.svg?style=for-the-badge\r\n[contributors-url]: https://github.com/BilHim/trafficSimulator/graphs/contributors\r\n[forks-shield]: https://img.shields.io/github/forks/BilHim/trafficSimulator.svg?style=for-the-badge\r\n[forks-url]: https://github.com/BilHim/trafficSimulator/forks\r\n[stars-shield]: https://img.shields.io/github/stars/BilHim/trafficSimulator.svg?style=for-the-badge\r\n[stars-url]: https://github.com/BilHim/trafficSimulator/stargazers\r\n[issues-shield]: https://img.shields.io/github/issues/BilHim/trafficSimulator.svg?style=for-the-badge\r\n[issues-url]: https://github.com/othneildrew/Best-README-Template/issues\r\n[license-shield]: https://img.shields.io/github/license/BilHim/trafficSimulator.svg?style=for-the-badge\r\n[license-url]: https://github.com/BilHim/trafficSimulator/blob/master/LICENSE\r\n[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555\r\n[linkedin-url]: https://www.linkedin.com/in/bilalhimite/\r\n[product-screenshot]: images/screenshot-1.png\r\n\r\n[Python]: https://img.shields.io/badge/python-306998?style=for-the-badge&logo=python&logoColor=white\r\n[Python-url]: https://www.python.org/\r\n\r\n[Numpy]: https://img.shields.io/badge/numpy-4b73c9?style=for-the-badge&logo=numpy&logoColor=white\r\n[Numpy-url]: https://numpy.org/\r\n\r\n[Scipy]: https://img.shields.io/badge/scipy-0054a6?style=for-the-badge&logo=scipy&logoColor=white\r\n[Scipy-url]: https://scipy.org/\r\n\r\n[DearPyGui]: https://img.shields.io/badge/DearPyGUI-306998?style=for-the-badge\r\n[DearPyGui-url]: https://github.com/hoffstadt/DearPyGui\r\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 Bilal Himite 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. ",
"summary": "A microscopic traffic simulation in Python",
"version": "0.0.1",
"split_keywords": [
"traffic",
"setuptools",
"development"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fe7888aa086ca7cc49cfc491a4f034c104f140da515f9f76faea6bde5afee1ad",
"md5": "19df5c3af4ddb975ed1da5dfd67ca0ee",
"sha256": "6d5d8d13ef4c67ed260aca0e9199880dc214f04aa686f7ba690ad8cdca87c1d4"
},
"downloads": -1,
"filename": "trafficSimulator-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "19df5c3af4ddb975ed1da5dfd67ca0ee",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 12841,
"upload_time": "2023-04-07T22:54:10",
"upload_time_iso_8601": "2023-04-07T22:54:10.266449Z",
"url": "https://files.pythonhosted.org/packages/fe/78/88aa086ca7cc49cfc491a4f034c104f140da515f9f76faea6bde5afee1ad/trafficSimulator-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "14e681974d14a360c11e501ad0f37eb1471f622520b895c6ba7a84f466995702",
"md5": "3ed5499a8d51b29844573bec30111a07",
"sha256": "b73349b30e922630ad334feb337100f93a087b6ba8eff9be22c3996abf12fe1e"
},
"downloads": -1,
"filename": "trafficSimulator-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "3ed5499a8d51b29844573bec30111a07",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 35477,
"upload_time": "2023-04-07T22:54:12",
"upload_time_iso_8601": "2023-04-07T22:54:12.640088Z",
"url": "https://files.pythonhosted.org/packages/14/e6/81974d14a360c11e501ad0f37eb1471f622520b895c6ba7a84f466995702/trafficSimulator-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-07 22:54:12",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "trafficsimulator"
}
