Skip to content

Commit

Permalink
Fixing links of the gallery (#189)
Browse files Browse the repository at this point in the history
* Pointing documentation links to AWS S3
  • Loading branch information
NewtonSander authored Aug 1, 2024
1 parent 53c919b commit 6fb78a9
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ LABEL org.opencontainers.image.source="https://github.com/agencyenterprise/neuro
RUN ./venv/bin/pip install .

WORKDIR /ndk/notebooks
RUN wget "https://agencyenterprise.github.io/neurotechdevkit/generated/gallery/gallery_jupyter.zip" -O temp.zip && unzip temp.zip && rm temp.zip
RUN wget "http://ndk-docs.s3-website.us-east-2.amazonaws.com/generated/gallery/gallery_jupyter.zip" -O temp.zip && unzip temp.zip && rm temp.zip

EXPOSE 8888
CMD ["/ndk/run_jupyter_server.sh"]
2 changes: 1 addition & 1 deletion Dockerfile-gpu
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ LABEL org.opencontainers.image.source="https://github.com/agencyenterprise/neuro
RUN ./venv/bin/pip install .

WORKDIR /ndk/notebooks
RUN wget "https://agencyenterprise.github.io/neurotechdevkit/generated/gallery/gallery_jupyter.zip" -O temp.zip && unzip temp.zip && rm temp.zip
RUN wget "http://ndk-docs.s3-website.us-east-2.amazonaws.com/generated/gallery/gallery_jupyter.zip" -O temp.zip && unzip temp.zip && rm temp.zip

EXPOSE 8888
CMD ["/ndk/run_jupyter_server.sh"]
Expand Down
2 changes: 1 addition & 1 deletion docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ Pull requests merged with the tag `norelease` will not trigger any of the action

### Gallery of examples

The examples you can find in the official [documentation](https://agencyenterprise.github.io/neurotechdevkit/generated/gallery/) are [python scripts](https://github.com/agencyenterprise/neurotechdevkit/tree/main/docs/examples) executed in CI.
The examples you can find in the official [documentation](http://ndk-docs.s3-website.us-east-2.amazonaws.com/generated/gallery/) are [python scripts](https://github.com/agencyenterprise/neurotechdevkit/tree/main/docs/examples) executed in CI.

Running these scripts is a resource intensive and time consuming task, for this reason we are using CircleCI instead of Github Actions (as we can choose a more powerful machine to execute the job).

Expand Down
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,11 @@ You can run `neurotechdevkit` inside a docker container with just a couple of st
> ```
> The command above will create a folder `notebooks` in your current directory where you can put your jupyter notebooks.
>
> We recommend downloading the `.zip` file with example notebooks from this [link](https://agencyenterprise.github.io/neurotechdevkit/generated/gallery/gallery_jupyter.zip), and extracting it into your local `notebooks` folder so you can access them from the docker.
> We recommend downloading the `.zip` file with example notebooks from this [link](http://ndk-docs.s3-website.us-east-2.amazonaws.com/generated/gallery/gallery_jupyter.zip), and extracting it into your local `notebooks` folder so you can access them from the docker.
### Local installation
To install and run **neurotechdevkit** locally check the [installation](https://agencyenterprise.github.io/neurotechdevkit/installation/) page.
To install and run **neurotechdevkit** locally check the [installation](http://ndk-docs.s3-website.us-east-2.amazonaws.com/installation/) page.
## Usage
Expand Down
4 changes: 2 additions & 2 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,9 +103,9 @@ As a last step **before running NDK**, follow the instructions below depending o
!!! note
After installing `neurotechdevkit` you can use [Jupyter](https://jupyterlab.readthedocs.io/en/stable/) to explore the package.

To get started, we recommend downloading the example notebooks from this [link](https://agencyenterprise.github.io/neurotechdevkit/generated/gallery/gallery_jupyter.zip).
To get started, we recommend downloading the example notebooks from this [link](http://ndk-docs.s3-website.us-east-2.amazonaws.com/generated/gallery/gallery_jupyter.zip).

**On Linux** you can download and extract the notebooks running the following commands:

1. `sudo apt-get update && sudo apt-get install -y unzip wget`
1. `wget "https://agencyenterprise.github.io/neurotechdevkit/generated/gallery/gallery_jupyter.zip" -O temp.zip && unzip temp.zip && rm temp.zip`
1. `wget "http://ndk-docs.s3-website.us-east-2.amazonaws.com/generated/gallery/gallery_jupyter.zip" -O temp.zip && unzip temp.zip && rm temp.zip`

0 comments on commit 6fb78a9

Please sign in to comment.