- Clone the repository
- This project uses Poetry for dependency and packaging management. You can use these installation instructions to add it to your system.
- If you choose to use poetry you can execute the following commands in a terminal while you are located in the repository folder:
poetry install
This will create a virtual environment and install all the necessary library dependencies. - If you do not choose to use poetry we first recommend creating a virtual environment and
then install the package and necessary dependencies by installing the .whl file in the dist folder. So in a terminal, while you are located in the repository folder, execute the following:
python -m venv venv
to create the virtual environmentvenv\Scripts\Activate.ps1
to activate itcd dist
to enter the dist folderpip install gpbp-0.1.0-py3-none-any.whl
to install the package
- Some example usage can be seen in the
examples/gpbp_showcase.ipynb
notebook - When in the
gpbp_app
folder you can run a Streamlit app to use the package using an interface. Specifically, while you are located in the repository folder, execute the following:
cd gpbp_app
to enter the application folderstreamlit run main_page.py
to run the app, which will automatically open a browser window