Skip to content

Commit

Permalink
Point to user guide in root instance README
Browse files Browse the repository at this point in the history
  • Loading branch information
dotsdl committed Nov 22, 2024
1 parent 2c4dc52 commit d8faabd
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions deployments/root/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
The [`root`](deployments/root) deployment is reachable by users at [https://api.alchemiscale.org](https://api.alchemiscale.org/redoc).
It is also often referred to as `prod` currently, but other instances used for "production" work may also be deployed from this repo over time.

## for users
## environment installation instructions for users

To use this instance, clone this repository, and switch to the currently-deployed tag:
To use this deployed instance, first clone this repository, and switch to the currently-deployed tag:

$ git clone https://github.com/OpenFreeEnergy/alchemiscale.org-deployment.git
$ cd alchemiscale.org-deployment
Expand All @@ -20,3 +20,5 @@ Once installed, activate the environment::
$ micromamba activate alchemiscale-client

You may wish to install other packages into this environment, such as `jupyterlab`.

See the [`alchemiscale` User Guide](https://docs.alchemiscale.org/en/latest/user_guide.html) for further details on how to connect and interact with the instance.

0 comments on commit d8faabd

Please sign in to comment.