Skip to content

README.md

Latest commit

 

History

History
40 lines (35 loc) · 809 Bytes

README.md

File metadata and controls

40 lines (35 loc) · 809 Bytes

Where2Share

Setup

  • Recommended python version: 3.12
  • Install graph-tool
  • Clone the repository:
git clone git@github.com: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 .env in the repository root to configure the DB connection:
DB_HOST=...
DB_PORT=...
DB_USER=...
DB_PASS=...
DB_NAME=...
  • Test the installation:
pytest

To test only "fast" tests, use:

pytest -m "not slow"

Documentation

After building it (during setup), just open doc/_build/html/index.html in your browser of choice.