Skip to content

Commit

Permalink
more grammar updates
Browse files Browse the repository at this point in the history
  • Loading branch information
jreadey committed May 13, 2024
1 parent 82cf6ac commit 7d67b4a
Showing 1 changed file with 11 additions and 7 deletions.
18 changes: 11 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,11 @@ From a release tarball or Git checkout::

pip install .

By default the examples look for a local instance of HSDS. See the https://github.com/HDFGroup/hsds
for instructions on installing and running HSDS.

These tests are also to designed to work with HSDS (see https://github.com/HDFGroup/hsds).
Install HSDS locally, or set environment variables (see next section)
to point to an existing HSDS instance.
Run `hsconfigure` to setup the connection info (endpoint, username, and password) to HSDS.
If you don't have access to an HSDS instance, you can easily setup your own HSDS instance.
See https://github.com/HDFGroup/hsds for instructions on installing and running HSDS
on locally or in the cloud.

Alternatively, if you can run this repo as a Github Codespace
(see "Open in a Github Codespace" link above), and HSDS will be automatically setup as part of the codespace.

Expand Down Expand Up @@ -106,7 +105,12 @@ Use the ``--help`` option to get usage information for each command.

Testing
-------
Setup the following environment variables that inform h5pyd which endpoint and username to use:

By default the test suite will attempt to connect to a local instance of HSDS with the
`http://localhost:5101` endpoint.

Use the following environment variables as needed to modify the default configuration
for the test suite:

* ``HS_ENDPOINT`` - "http://127.0.0.1:5000" for HSDS installed locally or appropriate remote endpoint
* ``HS_USERNAME`` - "test_user1" or your preferred username
Expand Down

0 comments on commit 7d67b4a

Please sign in to comment.