Skip to content

Commit

Permalink
Update Readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
redur committed May 31, 2024
1 parent dd33a21 commit 900ee43
Showing 1 changed file with 10 additions and 22 deletions.
32 changes: 10 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,34 +13,22 @@ The coordinate types LV95 as well as the older LV03 are supported. More informat
Only German and French borehole profiles are supported as of now.

## Installation
We use conda to create and manage the project's dependencies. The project comes with two environments, `environment-dev.yml` and `environment-prod.yml`, respectively. The prod environment contains all necessary dependencies to run the code and extraction pipelines therein. All dependencies that are useful for the development of the code, but not to run it, are separated into the dev environment.

Assuming you have conda installed and cloned the repository, run the following command in your project repository:
```bash
conda env create -f environment-prod.yml
```

If you would like to get all developer functionalities, run:

```bash
conda env create -f environment-dev.yml
```
We use pip to manage the packages dependencies. We recommend using a virtual environment within which to install all dependencies.

Local installation for development: `pip install -e .[all]`
Installation from source for production scenarios: `pip install git+https://github.com/swisstopo/swissgeol-boreholes-dataextraction.git"

## Run data extraction
To execute the data extraction pipeline, follow these steps:

1. **Activate the Conda environment**

If you haven't already, activate the conda environment using the following command:

```bash
conda activate boreholes-prod
````

If you are developing and testing the code, you might want to use the dev environment instead:
1. **Activate the virtual environment**

`conda activate boreholes-dev`
Activate your virtual environment and install the package. On unix systems this is
```bash
python -m venv env
source env/bin/activate
pip install -e .[all]
```

2. **Download the borehole profiles, optional**

Expand Down

0 comments on commit 900ee43

Please sign in to comment.