Installation
This guide will help you get started with the project by cloning the repository and installing the package locally.
Cloning the Repository
The first example requires a properly set up ssh key (further explanation on GitHub). Alternatively, one can use HTTPS for cloning the repository if SSH is not an option or if you prefer not to set up an SSH key. Using HTTPS does not require any additional setup beyond having a GitHub account and your credentials.
Create a new folder for openKARST for example '/openkarst_dev' and navigate to it:
Cloning with SSH
or when using SSH over the HTTPS port (in case of blocked ports)
Cloning with HTTPS
Local Installation
To install the package locally, you have two options: a regular local install and an editable install. If you plan to modify the code, the latter one ("development install") is recommended. A regular install copies the package files to the Python environment's package directory. This method is suitable if you do not intend to modify the code.
An editable install, also known as a "development install," adds the package directory to Python’s import path without copying files. This allows for immediate testing of any changes made to the code. This method is ideal for development and testing purposes.
Regular local install
Navigate to the cloned directory, i.e., where the pyproject.toml file is located and run the following command: