diff --git a/README.md b/README.md index 43b0029..ab0851f 100644 --- a/README.md +++ b/README.md @@ -136,7 +136,7 @@ sap.save(r'\Path\to\save\file.sdb') ### 3.1. GUI -The repo now supports a streamlit GUI for the wrapper. Checkout [`GUI.md`](/documentation/Usage/GUI.md) for instructions. +The repo has an optional streamlit GUI for the wrapper. Checkout [`GUI.md`](/documentation/Usage/GUI.md) for installation and usage instructions. ### 3.2. Layout Documentation diff --git a/documentation/Usage/GUI.md b/documentation/Usage/GUI.md index c66f4dd..f851480 100644 --- a/documentation/Usage/GUI.md +++ b/documentation/Usage/GUI.md @@ -17,6 +17,12 @@ The package not comes pre-compiled with the streamlit package. cd ak_sap ``` +- Install dependencies + + ```bash + pip install flit && flit install + ``` + - Launch the app run ```bash @@ -26,7 +32,7 @@ The package not comes pre-compiled with the streamlit package. - Alternatively, In windows launch by executing the script ```cmd - cd scripts\win + cd scripts run.bat ``` @@ -64,6 +70,7 @@ Steps: 8. The exported file will be of format "`SAP filename`-`Selected Node #`-`Selected Section Shape`-`MMDD`_`HHMM`.pe" To Implement: + - [ ] Incorporate the section profile into the `.pe` file. - [ ] Replace the manual deletion of existing loadcase with inbuilt `delete_existing` method of Hilti-Profis Class in version `0.0.4`. - [ ] Defer data generation until the click of download button (Part of Streamlit roadmap for May-July 2024). \ No newline at end of file diff --git a/pyproject.toml b/pyproject.toml index 29dd22b..4a2ef0c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -13,13 +13,9 @@ dynamic = ["version", "description"] dependencies = [ "comtypes==1.2.0", "forallpeople==2.6.7", - "keyring==24.3.0", "pandas==2.1.3", "rich==13.7.0", - "typer[all]==0.9.0", - "pytest==7.4.3", - "streamlit==1.31.0", - "hilti_profis==0.0.3" + "typer[all]==0.9.0" ] [project.optional-dependencies] @@ -28,7 +24,10 @@ dev = [ "ipykernel", "ipywidgets", "pandasgui", - "line-profiler" + "line-profiler", + "pytest==7.4.3", + "streamlit==1.31.0", + "hilti_profis==0.0.3" ] [project.urls]