Developer Guide¶

Setting up devloper environment¶

Checking out develop branch of SimDB:

git clone https://github.com/iterorganization/SimDB.git
cd simdb
git checkout develop

Create a virtual environment:

python3 -m venv venv
source venv/bin/activate

Installing editable version of SimDB:

pip install -e .

Installing server dependencies:

pip install -e .[all]

In the SimDB root directory run:

pytest

simdb_server

This will start a server on port 5000. You can test this server is running by opening htpp://localhost:5000 in a browser.

This section will guide to setting up a PostgreSQL server for SimDB.

Setup PostgreSQL configuration and data directory

mkdir $HOME/Path/To/PostgresSQL_Data

Initialize database with data directory

initdb -D $HOME/Path/To/PostgresSQL_Data -U simdb

Start database server

pg_ctl -D $HOME/Path/To/PostgresSQL_Data/ -l logfile start

Verify database server status and should prompt /tmp:5432 - accepting connections

pg_isready

Creates a database named simdb

createdb simdb -U simdb

Access database from command-line. It will prompt simdb=#

psql -U simdb

Update [database] section of app.cfg

...

[database]
type = postgres
host = localhost
port = 5432

...