diff --git a/README.md b/README.md index a38c31d2..09a9d58e 100644 --- a/README.md +++ b/README.md @@ -39,8 +39,7 @@ Use pip to install this library directly from PyPI: [![asciicast](https://asciinema.org/a/TZJg5BglDMFM2fEEX9dSpnJEy.svg)](https://asciinema.org/a/TZJg5BglDMFM2fEEX9dSpnJEy) If you wish to install directly from this repository see the instructions below to either build -a packaged version of `pypet2bids` or how to run the code directly from source. -If you are unable to install this library from PyPi you can clone this repository to build and install the package as distributed on PyPi yourself +a packaged version of `pypet2bids` or how to run the code from source.
Build Package Locally and Install with PIP diff --git a/docs/installation.rst b/docs/installation.rst index b47056a5..21e96932 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -36,7 +36,7 @@ via pip for Python versions >3.7.1,=<3.11 -If you wish to contribute, are unable to install from PyPi, or simply wish to install pypet2bids from source, continue +If you wish to contribute, are unable to install from PyPi, or simply wish to run pypet2bids from source, continue reading the `Additional Install Notes`_ section below. Additional Install Notes @@ -80,7 +80,14 @@ Python ------ If you are unable to install this library from PyPi you can clone this repository to build and install the package -as distributed on PyPi yourself with poetry: +as distributed on PyPi yourself with poetry. + +We use `poetry `_ to build this package, no other build methods are supported, +further we encourage the use of `GNU make `_ and a bash-like shell to simplify the +build process. + +After installing poetry, you can build and install this package to your local version of Python with the following +commands (keep in mind the commands below are executed in a bash-like shell): .. code-block:: diff --git a/pypet2bids/pypet2bids/sidecar.py b/pypet2bids/pypet2bids/sidecar.py index d74c5b70..9a9ed263 100644 --- a/pypet2bids/pypet2bids/sidecar.py +++ b/pypet2bids/pypet2bids/sidecar.py @@ -7,8 +7,8 @@ imaging data :return: sidecar_template_full, sidecar_template_short -|*Anthony Galassi* -|*Copyright OpenNeuroPET team* +*Anthony Galassi* +*Copyright OpenNeuroPET team* """