|
|
|
# JPScore
|
|
|
|
`jpscore` is the core module for simulation and computing of the trajectories.
|
|
|
|
|
|
|
|
It is called with an initialization file e.g.:
|
|
|
|
|
|
|
|
```
|
|
|
|
jpscore config.xml
|
|
|
|
```
|
|
|
|
|
|
|
|
with `config.xml` a structured `xml` project file containing parameter definitions, agents distributions and other
|
|
|
|
important configurations to run a simulation.
|
|
|
|
|
|
|
|
___
|
|
|
|
**Important**: When reporting bugs, please make sure to use the development branch *(v0.8)*.
|
|
|
|
___
|
|
|
|
|
|
|
|
The online documentation can be found in the project's [GitHub pages](http://jupedsim.github.io/jpscore/).
|
|
|
|
|
|
|
|
- User guide:
|
|
|
|
- [Requirements](docs/user_guide/requirements)
|
|
|
|
- [Configuration](docs/user_guide/configuration)
|
|
|
|
- [Vagrant](docs/user_guide/vagrant)
|
|
|
|
- [Quickstart](docs/user_guide/quickstart)
|
|
|
|
- [File formats](docs/user_guide/data_formats)
|
|
|
|
|
|
|
|
- Contributing:
|
|
|
|
- [Code Style](docs/contributing/code-Style-Conventions)
|
|
|
|
- [Workflow](docs/contributing/workflow)
|
|
|
|
- [Unit testing](docs/contributing/utest)
|
|
|
|
|
|
|
|
- Models:
|
|
|
|
- [Operational models](docs/models/operativ)
|
|
|
|
- [Direction strategies](docs/models/direction)
|
|
|
|
- [Routing](docs/models/routing)
|
|
|
|
- About:
|
|
|
|
- [Disclaimer](docs/about/disclaimer)
|
|
|
|
- [License](docs/about/LICENSE)
|
|
|
|
- [Contributors](docs/about/contributors)
|
|
|
|
|
