Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
zm711 authored Aug 2, 2024
1 parent 601404c commit 7a2494b
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# phy: interactive visualization and manual spike sorting of large-scale ephys data

[![Build Status](https://travis-ci.org/cortex-lab/phy.svg)](https://travis-ci.org/cortex-lab/phy)
[![Install and Test with Pip](https://github.com/cortex-lab/phy/actions/workflows/python-test.yml/badge.svg)](https://github.com/cortex-lab/phy/actions/workflows/python-test.yml)
[![codecov.io](https://img.shields.io/codecov/c/github/cortex-lab/phy.svg)](http://codecov.io/github/cortex-lab/phy)
[![Documentation Status](https://readthedocs.org/projects/phy/badge/?version=latest)](https://phy.readthedocs.io/en/latest/?badge=latest)
[![GitHub release](https://img.shields.io/github/release/cortex-lab/phy.svg)](https://github.com/cortex-lab/phy/releases/latest)
Expand Down Expand Up @@ -39,7 +39,7 @@ There are no specific GPU requirements as long as relatively recent graphics and

## Installation instructions

Run the following commands in a terminal:
Run the following commands in a terminal (currently working for Linux machines):

1. Create a new conda environment with the conda dependencies:

Expand Down Expand Up @@ -75,7 +75,7 @@ In some environments, you might get an error message related to QtWebEngineWidge
* It is recommended to delete `~/.phy/*GUI/state.json` when upgrading.


### Developer instructions
### Developer instructions (and instructions for some Windows machines)

To install the development version of phy in a fresh environment, do:

Expand All @@ -91,6 +91,11 @@ cd phylib
pip install -e . --upgrade
```

### Mac Install

Since the switch to M-series chips Mac install for Phy is not being officially supported.
Rarely people are able to hack together a version with old versions of python etc.

### Troubleshooting

* [See a list of common issues.](https://phy.readthedocs.io/en/latest/troubleshooting/)
Expand Down

0 comments on commit 7a2494b

Please sign in to comment.