add install instructions to README
This commit is contained in:
29
README.md
29
README.md
@ -1,3 +1,32 @@
|
||||
# bern02-ex1-workflows-fair
|
||||
|
||||
Assignment 1: Workflows and FAIR principles
|
||||
|
||||
This repository contains code from previous coursework, but organised and formatted in such a way as to adhere to the FAIR principles.
|
||||
|
||||
# Installation
|
||||
|
||||
> NOTE: This guide assumes you have a working installation of Python 3 and git on a unix-like (Linux, MacOS) system.
|
||||
|
||||
First, clone the repository:
|
||||
|
||||
```
|
||||
git clone https://git.pimnel.com/pim/bern02-ex1-workflows-fair
|
||||
```
|
||||
|
||||
You need to create a virtual environment to run the code in. To create a virtual environment and install the required packages, do the following:
|
||||
|
||||
```
|
||||
cd bern02-ex1-workflows-fair
|
||||
python3 -m venv .venv
|
||||
source .venv/bin/activate
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
With the virtual environment still active, run
|
||||
|
||||
```
|
||||
jupyter notebook
|
||||
```
|
||||
|
||||
to start working with the notebook in your default browser.
|
Reference in New Issue
Block a user