sync with online documentation authored by Mohcine Chraibi's avatar Mohcine Chraibi
# JPScore # JPScore
[![build status](https://travis-ci.org/JuPedSim/jpscore.svg?branch=v0.8)](https://travis-ci.org/JuPedSim/jpscore)
[![codecov.io](https://codecov.io/github/JuPedSim/jpscore/coverage.svg?branch=v0.8)](https://codecov.io/github/JuPedSim/jpscore?branch=v0.8)
`jpscore` is the core module for simulation and computing of the trajectories. `jpscore` is the core module for simulation and computing of the trajectories.
___ ___
**Important**: When reporting bugs, please make sure to use the development branch *(v0.8)*. **Important**: When reporting bugs, please make sure to use the development branch *develop*.
___ ___
The online documentation can be found in the project's [GitHub pages](http://jupedsim.github.io/jpscore/). The online documentation can be found in the project's [GitHub pages](http://jupedsim.com/jpscore/).
<div class="jumbotron">
<p><code>JPScore</code> implements models on the operational as well as on the tactical level.
<p>This software is platform independent, released under the <a href="{{ site.baseurl }}/disclaimer.html">LGPL</a> license and is written in C++ and Python.</p>
<center>
<!-- <div class="btn-group"> -->
<a class="btn btn-primary btn-lg" href="https://cst.version.fz-juelich.de/jupedsim/jpscore">
&nbsp;&nbsp;&nbsp;&nbsp;Code &nbsp;&nbsp;&nbsp;&nbsp;
</a>
<a class="btn btn-success btn-lg" href="docs/2016-11-04-contributing">
Contribute
</a>
<a class="btn btn-danger btn-lg" href="docs/2016-11-02-quickstart">
&nbsp;&nbsp;&nbsp;&nbsp;Start&nbsp;&nbsp;&nbsp;&nbsp;
</a>
<!-- </div> -->
</center>
</div>
- About:
- [Introduction](2016-11-01-introduction)
- [Disclaimer](docs/about/disclaimer)
- [License](docs/about/LICENSE)
- [Contributors](docs/about/contributors)
- User guide: - User guide:
- [Requirements](docs/user_guide/requirements) - [Quickstart](docs/user_guide/2016-11-02-Quickstart)
- [Configuration](docs/user_guide/configuration) - [Requirements](docs/2016-11-03-Requirements)
- [Vagrant](docs/user_guide/vagrant)
- [Quickstart](docs/user_guide/quickstart)
- [File formats](docs/user_guide/data_formats)
- Contributing: - Contributing:
- [Code Style](docs/contributing/code-Style-Conventions) - [Contributing](docs/2016-11-04-Contributing)
- [Workflow](docs/contributing/workflow)
- [Unit testing](docs/contributing/utest) - File formats:
- [Inifile](docs/2016-11-01-inifile)
- [Geometry](docs/2016-11-02-geometry)
- [Trajectories](docs/2016-11-03-trajectory)
- Models: - Models:
- [Operational models](docs/models/operativ) - [Operational models](docs/2016-11-01-operativ)
- [Direction strategies](docs/models/direction) - [Direction strategies](docs/2016-11-02-direction)
- [Routing](docs/models/routing) - [Routing](docs/2016-11-03-routing)
- Tests: - Tests:
- [Introduction](docs/tests/introduction) - [RiMEA](docs/2016-11-01-rimea)
- [RiMEA](docs/tests/rimea) - [Juelich](docs/2016-11-02-juelich)
- [Juelich](docs/tests/juelich)
- About:
- [Disclaimer](docs/about/disclaimer)
- [License](docs/about/LICENSE)
- [Contributors](docs/about/contributors)
- [Publications](publications.markdown) - [Publications](docs/2016-11-05-Publications)