Skip to content

Commit 3cefc7d

Browse files
committed
Move GCP info to contributing info
[skip ci]
1 parent 8a69e26 commit 3cefc7d

File tree

3 files changed

+25
-20
lines changed

3 files changed

+25
-20
lines changed

CONTRIBUTING.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,3 +161,27 @@ a release:
161161
5. Check that release has been deployed to PyPI
162162
6. Check documentation is built and deployed to readthedocs
163163
7. Check that auto-generated PR is auto-merged on the conda-forge feedstock repo
164+
165+
## Dashboard
166+
A live dashboard is available at:
167+
168+
https://simdec.io
169+
170+
The DNS records are available on CPanel and the rest is hosted on Google Cloud
171+
Platform.
172+
173+
Developing locally requires the installation of GCP CLI and Docker engine.
174+
175+
A few helper commands are provided in the Makefile.
176+
177+
### Local use
178+
179+
The dashboard can be run locally using:
180+
181+
make serve
182+
183+
### Deployment
184+
185+
To deploy a new version:
186+
187+
PANEL_TOKEN=... make production

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ prepare: ## Install dependencies and pre-commit hook
3030
pip install -e ".[dev]"
3131
pre-commit install
3232
gcloud init
33-
gcloud auth configure-docker
33+
gcloud auth configure-docker europe-north1-docker.pkg.dev
3434

3535
doc: ## Build Sphinx documentation
3636
sphinx-build -b html docs docs/html

README.md

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -27,30 +27,11 @@ The library is distributed on PyPi and can be installed with:
2727

2828
pip install simdec
2929

30-
To install the development version, download the source and from the root of
31-
the repository:
32-
33-
pip install -e .[dev]
34-
3530
## Dashboard
3631
A live dashboard is available at:
3732

3833
https://simdec.io
3934

40-
### Local use
41-
42-
The dashboard can be run locally using:
43-
44-
make serve
45-
46-
### Deployment
47-
48-
The live version of the dashboard is hosted on GCP. To deploy a new version:
49-
50-
PANEL_TOKEN=... make production
51-
52-
###
53-
5435
## Citations
5536

5637
The algorithms and visualizations used in this package came primarily out of

0 commit comments

Comments
 (0)