Skip to content

Commit

Permalink
Fixed broken links and removed material that isn't ready yet.
Browse files Browse the repository at this point in the history
  • Loading branch information
Patrick Nicodemus committed Sep 12, 2024
1 parent e428b1f commit a227950
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 14 deletions.
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Online! We'll share a Zoom link ahead of the workshop.
September 23rd-24th. It's two half days to make sure people in both US and Europe can attend. Please see the [Schedule](schedule.md) for details.

## :star_struck: Interested?
Registration is still open via [Google Forms](https://forms.gle/twx3ne3HHoV48eMS8).
Registration is closed as of September 12, 2024.

## :rocket: Already signed up?

Expand Down
24 changes: 17 additions & 7 deletions docs/preparing.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ In general, we expect you to have at least basic familiarty with Python includin
Most of the workshop will be using [Jupyter](https://jupyter.org/) for interactive data analysis. Please see their website for install instructions.

## Prerequisites
Windows, MacOS, and Linux should all work.
Windows, MacOS, and Linux should all work. You can also run Python in a Jupyter notebook in the cloud, using Google Colab.

The tutorials are compatible with Python version >= 3.9. You should have a current version of pip (>= 23) and setuptools (>= 68)

Expand All @@ -27,6 +27,8 @@ In order to avoid dependency conflicts with other Python packages on your device
including packages managed by the system package manager rather than pip or conda, you should create a virtual environment to install
all Python packages that will be used in the workshop. Start by navigating to the directory in which you plan to work, and follow the instructions appropriate for your package manager.

Alternatively, if you plan to use Google Colab for everything, you can skip to that section.

## Dependencies
The workshop will focus on four main packages.

Expand All @@ -38,36 +40,37 @@ The workshop will focus on four main packages.

[Pynapple](https://github.com/pynapple-org/pynapple) is a light-weight python library for neurophysiological data analysis.

[:octicons-arrow-right-24: Install instructions](pynapple/pynapple_setup.md)
<!-- [:octicons-arrow-right-24: Install instructions](pynapple/pynapple_setup.md) -->

- :material-cube:{ .lg .middle } __NeMoS__

---

[NeMoS](https://github.com/flatironinstitute/nemos) (Neural ModelS) is a statistical modeling framework optimized for systems neuroscience and powered by JAX.

[:octicons-arrow-right-24: Install instructions](nemos/nemos_setup.md)
<!-- [:octicons-arrow-right-24: Install instructions](nemos/nemos_setup.md) -->

- :material-eye-arrow-right:{ .lg .middle } __CAJAL__

---

[CAJAL](https://github.com/CamaraLab/CAJAL) is a Python library for multi-modal cell morphology analyses using Gromov-Wasserstein (GW) distance.

[:octicons-arrow-right-24: Install instructions](cajal/cajal_setup.md)
<!-- [:octicons-arrow-right-24: Install instructions](cajal/cajal_setup.md) -->

- :material-camera-control: __Navis__

---

[Navis](https://github.com/navis-org/navis) is a package for **N**euron **A**nalysis and **Vis**ualization.

[:octicons-arrow-right-24: Install instructions](navis/navis_setup.md)
<!-- [:octicons-arrow-right-24: Install instructions](navis/navis_setup.md) -->


</div>

In addition to these core tools, we will rely on some other software:

- Scanpy, a Python package for the analysis of single-cell gene expression data
- Jupyter, an interactive environment for evaluating Python code and plotting graphs
- ipywidgets, which extends the functionality of Jupyter (e.g., progress bars)
Expand Down Expand Up @@ -115,6 +118,13 @@ pip install cajal navis pynnapple nemos
```
and pip should install the relevant dependencies into the ./neuro_workshop directory you have just created.

## Download the Data
## Google Colab
Google Colab is a cloud computing service which can execute Jupyter notebooks stored in Google Drive. To use Google Colab for this tutorial, go to https://colab.research.google.com/ and click "File > New Notebook in Drive"

Install Python dependencies using Jupyter's pip magic command:
```
%pip install cajal scanpy leidenalg navis umap-learn pandas plotly pynapple nemos matplotlib requests
```

_TODO_
## Getting Help
The workshop organizers can be contacted for installation help in the [Slack group](https://join.slack.com/t/pythontoolsfo-ehx1178/shared_invite/zt-2qjzd1c44-NZ~9kt0~kh47X6t80tK8Mg) for the workshop.
10 changes: 4 additions & 6 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,10 @@ nav:
- Schedule: schedule.md
- Preparation:
- preparing.md
- NeMos: nemos/nemos_setup.md
- Pynapple: pynapple/pynapple_setup.md
- CAJAL: cajal/cajal_setup.md
- Navis: navis/navis_setup.md


# - NeMos: nemos/nemos_setup.md
# - Pynapple: pynapple/pynapple_setup.md
# - CAJAL: cajal/cajal_setup.md
# - Navis: navis/navis_setup.md

theme:
name: "material"
Expand Down

0 comments on commit a227950

Please sign in to comment.