Skip to content

Commit 7c28ba2

Browse files
committed
Update install instructions
1 parent 44ae31a commit 7c28ba2

File tree

1 file changed

+21
-5
lines changed

1 file changed

+21
-5
lines changed

README.md

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# DynamicalSystemFramework
22
[![Latest Release](https://img.shields.io/github/v/release/physycom/DynamicalSystemFramework)](https://github.com/physycom/DynamicalSystemFramework/releases/latest)
3+
[![PyPI version](https://img.shields.io/pypi/v/dsf-mobility)](https://pypi.org/project/dsf-mobility/)
34
[![Standard](https://img.shields.io/badge/C%2B%2B-20/23-blue.svg)](https://en.wikipedia.org/wiki/C%2B%2B#Standardization)
45
[![TBB](https://img.shields.io/badge/TBB-2021.11.0-blue.svg)](https://github.com/oneapi-src/oneTBB)
56
[![SPDLOG](https://img.shields.io/badge/spdlog-1.12.0-blue.svg)](https://github.com/gabime/spdlog)
@@ -11,15 +12,29 @@ The aim of this project is to rework the original [Traffic Flow Dynamics Model](
1112
This rework consists of a full code rewriting, in order to implement more features (like *intersections*) and get advantage from the latest C++ updates.
1213

1314
## Table of Contents
14-
- [Requirements](#requirements)
1515
- [Installation](#installation)
16+
- [Installation (from source)](#installation-from-source)
1617
- [Testing](#testing)
1718
- [Benchmarking](#benchmarking)
1819
- [Citing](#citing)
1920
- [Bibliography](#bibliography)
2021

21-
## Requirements
22+
## Installation
23+
The library is available on `PyPI`:
24+
```shell
25+
pip install dsf-mobility
26+
```
27+
28+
To check the installation you can simply run
29+
```python
30+
import dsf
2231

32+
print(dsf.__version__)
33+
```
34+
35+
## Installation (from source)
36+
37+
### Requirements
2338
The project requires `C++20` or greater, `cmake`, `tbb` `simdjson`, and `spdlog` (with `fmt`).
2439
To install requirements on Ubuntu:
2540
```shell
@@ -34,8 +49,7 @@ Utilities are written in python. To install their dependencies:
3449
```shell
3550
pip install -r ./requirements.txt
3651
```
37-
38-
## Installation
52+
### Installation (C++)
3953
The library can be installed using CMake. To build and install the project in the default folder run:
4054
```shell
4155
cmake -B build -DCMAKE_BUILD_TYPE=Release && cmake --build build
@@ -51,7 +65,7 @@ cmake --build build
5165
cmake --install build
5266
```
5367

54-
## Installation via Pybind11
68+
## Installation (Python)
5569
If you want to use the library from Python, you can build the Python bindings using [pybind11](https://github.com/pybind/pybind11). Make sure you have doxygen installed to generate the docstrings:
5670
```shell
5771
sudo apt install doxygen
@@ -65,6 +79,8 @@ pip install .
6579
After installation, you should be able to import the module in Python:
6680
```python
6781
import dsf
82+
83+
print(dsf.__version__)
6884
```
6985

7086
If you encounter issues, ensure that the installation path is in your `PYTHONPATH` environment variable.

0 commit comments

Comments
 (0)