- Recommended python version: 3.12
- Install graph-tool
- Clone the repository:
git clone [email protected]:PhysicsOfMobility/where2share.git
cd where2share
pip install -e .[dev,doc]
sphinx-build -W -j7 -b html doc/source doc/_build/html
pre-commit install- Alternatively,
pip-install directly:
pip install "where2share@git+https://github.com/PhysicsOfMobility/where2share"- Create a file called
.envin the repository root to configure the DB connection:
DB_HOST=...
DB_PORT=...
DB_USER=...
DB_PASS=...
DB_NAME=...- Test the installation:
pytestTo test only "fast" tests, use:
pytest -m "not slow"After building it (during setup), just open doc/_build/html/index.html in your browser
of choice.