Skip to content

Latest commit

 

History

History
54 lines (39 loc) · 998 Bytes

File metadata and controls

54 lines (39 loc) · 998 Bytes

Ibex backend

Installation

Requirements

Load required modules

module load IDStools IMAS-Python

Development setup

python -m venv venv
. venv/bin/activate

# in `backend` directory
pip install -e . # editable mode allows changes to have instant impact

Development run

./bin/run_ibex_service

>...
>Uvicorn running on http://127.0.0.1:<port_number>
>...

# start firefox and open localhost:<port_number>/docs to explore endpoints

# you can also specify port number when running service
./bin/run_ibex_service -p 8000

Documentation build

. venv/bin/activate
pip install -U sphinx sphinx-autosummary-accessors sphinx_immaterial

make -C docs html

Testing

python -m pytest tests/ #make sure to run pythest with python -m. Otherwise it won't see installed fastapi packages

Benchmarking

./ci/run_benchmarks.sh
# results will be saved in `cwd`/ibex_benchmarks