Installing a Development Environment#

To contribute to hdf5view, please fork the repository.

Set up a virtual environment, called e.g. “dev_hdf5view” using venv in Python [1]:

python -m venv dev_hdf5view

Change directories into your virtual environment and clone your forked repository into it (replacing “your-username” in the code below):

cd dev_hdf5view
git clone https://github.com/your-username/hdf5view.git

Activate the virtual environment:

.\Scripts\Activate.ps1
source bin/activate
source bin/activate

Set the upstream remote to the main hdf5view repository:

cd hdf5view
git remote add upstream https://github.com/tgwoodcock/hdf5view.git

Install hdf5view in editable mode with the optional dependencies for development:

pip install -e .[dev]

Footnotes