Installation

If you don’t have pip installed, this Python installation guide can guide you through the process.

Stable release

To install hsamiplus, run this command in your terminal:

python -m pip install hsamiplus

This is the preferred method to install hsamiplus, as it will always install the most recent stable release.

From sources

The sources for hsamiplus can be downloaded from the Github repo.

  1. Download the source code from the Github repo using one of the following methods:

    • Clone the public repository:

      git clone git@github.com:hydrologie/hsamiplus.git
      
    • Download the tarball:

      curl -OJL https://github.com/hydrologie/hsamiplus/tarball/main
      
  2. Once you have a copy of the source, you can install it with:

    python -m pip install .
    
  3. When new changes are made to the Github repo, if using a clone, you can update your local copy using the following commands from the root of the repository:

    git fetch
    git checkout main
    git pull origin main
    python -m pip install .
    

    These commands should work most of the time, but if big changes are made to the repository, you might need to remove the environment and create it again.