TrafficSimulator

<!-- 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">

</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 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 on Medium.

<p align="right">(<a href="#readme-top">back to top</a>)</p>

Built With

• 
• 
• 
• 

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, Bibcode:2000PhRvE..62.1805T, doi:10.1103/PhysRevE.62.1805, PMID 11088643, S2CID 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

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:

import trafficSimulator as ts

For more examples, please refer to the 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.

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 for more information.

<p align="right">(<a href="#readme-top">back to top</a>)</p> <!-- CONTACT -->

Contact

Bilal Himite

• LinkedIn: @bilalhimite
• Medium: @bilhim
• Email: hello@bilalhimite.me
• Portfolio: bilalhimite.me

Project Link: 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 -->