Skip to content

pni-lab/connattractor

Repository files navigation

connattractor

GitHub license GitHub release Docker Image Version (latest semver) Docker Image Size (latest semver) Binder

Laboratory for Predictive Neuroimaging - University Hospital Essen, Germany

Webpage with manuscript and getting started guide

https://pni-lab.github.io/connattractor

How to install the connattractor package?

The package 'connattractor' is available on PyPI!

pip install connattractor

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
    • Open in GitHub Codespaces (click code on top right on the github page of the repo)
  • Set up everything locally with docker

    • install docker
    • clone the repo and start your notebook in a docker container
      git clone https://github.com/pni-lab/connattractor.git
      cd connattractor
      docker run -it -v $PWD:/mounted/connattractor -p 8080:8080 -p 8888:8888 pnilab/connattractor:latest jupyter notebook
    • 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

How to render the web-page locally?

cd docs
myst start