https://github.com/yinchi/histopath-bim-des
BIM-DES integration demo
https://github.com/yinchi/histopath-bim-des
bim-applications discrete-event-simulation healthcare
Last synced: 26 days ago
JSON representation
BIM-DES integration demo
- Host: GitHub
- URL: https://github.com/yinchi/histopath-bim-des
- Owner: yinchi
- License: mit
- Created: 2024-05-04T20:44:49.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-05-09T09:39:35.000Z (12 months ago)
- Last Synced: 2025-02-07T09:18:56.768Z (3 months ago)
- Topics: bim-applications, discrete-event-simulation, healthcare
- Language: Python
- Homepage: https://yinchi.github.io/histopath-bim-des/
- Size: 5.08 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Histopathology BIM-DES integration demo
[](https://github.com/yinchi/histopath-bim-des/blob/main/LICENSE)
[](https://yinchi.github.io/histopath-bim-des/)
**Maintainer:** Yin-Chi Chan, Institute for Manufacturing, University of Cambridge
**Authors:**
- [Yin-Chi Chan](https://yinchi.github.io), University of Cambridge (BIM-DES integration, simulation modules)
- [Nicola Moretti](https://profiles.ucl.ac.uk/89826), University College London (BIM-DES integration)
## Developer Setup
**VSCode and WSL2 (for Windows users)**
It is recommended to work on this project using Visual Studio Code with WSL2, which provides a
Linux environment on Windows. See
[this tutorial](https://learn.microsoft.com/en-us/windows/wsl/tutorials/wsl-vscode) on
how to set up VSCode and WSL2.
**Cloning the repository**
```bash
git clone https://github.com/yinchi/histopath-bim-des.git
cd histopath-bim-des
# Open the newly cloned repo in VS Code
code .
```
**Installing the project and its dependencies**
This project uses the [Poetry](https://python-poetry.org/) package manager.
To set up the project on your local computer, run:
```bash
# Installs poetry system-wide
sudo apt install python3-poetry
# optional
poetry config virtualenvs.in-project true
poetry install
```
Other useful Poetry commands include `add`, `remove`, and `run`. As this project is not meant to
be used as a library, the `build` and `publish` commands are not recommended.
## scripts.sh
`scripts.sh` contains functions for Sphinx documentation. To use these, run the following in `bash`:
```bash
poetry shell
# in the new bash subshell:
source scripts.sh
clean-docs # reset the /docs directory
build-docs
serve-docs # defaulting to port 8000
# use CTRL+D to exit to the base shell.
```
`scripts.sh` also provides `projroot()` for quickly changing to the root of the project directory,
as well as adding `script/` to the `PATH` environment variable.