Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #27

Merged
merged 1 commit into from
Nov 21, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 9 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,23 +13,21 @@ Laboratory for Predictive Neuroimaging - University Hospital Essen, Germany

## How to install the connattractor package?

The package 'connattractor' will be soon available on PyPI.

Afterwards the preferred way to install it will be:
The package 'connattractor' is available on PyPI!

```
pip install connattractor
```

For now, the easiest way to try out the package is using docker, see below:

## How to re-run the analyses?

- **Install the PyPI package**
- run the notebooks in connattractor/notebooks

- **Run the analyses with 1 click (in the cloud)**
- [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/pni-lab/connattractor/HEAD)
- Open in GitHub Codespaces (click `code` on top right on the github page of the repo)

- **Set up everything to run in 5 mins (locally on your computer)**
- **Set up everything locally with docker**
- install [docker](https://www.docker.com/)
- clone the repo and start your notebook in a docker container
```bash
Expand All @@ -40,10 +38,10 @@ For now, the easiest way to try out the package is using docker, see below:
- copy paste the last link in your browser to start the notebook

- **Bare-metal** (developers)
- clone this repository with git as above
- set up a python environment (e.g with conda)
- install all requirements from requirements.txt
- start developing
- clone this repository with git as above
- set up a python environment (e.g with conda)
- install all requirements from requirements.txt
- start developing

## How to render the web-page locally?
```bash
Expand Down
Loading