Skip to content

Update installation.md #2379

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MMathisLab merged 1 commit into from
Sep 13, 2023
+6 −5
Merged

Update installation.md #2379

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions docs/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
Download anaconda for your operating system: https://www.anaconda.com/distribution/.
```

- IF you use a M1 or M2 chip in your MacBook with v12.5+ (typically 2020 or newer machines), you should use **miniconda3,** which operates with the same principles as anaconda. This is straight forward and explained in detail here: https://docs.conda.io/projects/conda/en/latest/user-guide/install/macos.html. But in short, open the program "terminal" and copy/paste and run:
- IF you use a M1 or M2 chip in your MacBook with v12.5+ (typically 2020 or newer machines), you should use **miniconda3,** which operates with the same principles as anaconda. This is straight forward and explained in detail here: https://docs.conda.io/projects/conda/en/latest/user-guide/install/macos.html. But in short, open the program "terminal" and copy/paste and run the code that is supplied below.

#### 💡 miniconda for Mac
````{admonition} Click the button to see code for miniconda for Mac
Expand All @@ -31,9 +31,9 @@ source ~/miniconda/bin/activate
conda init zsh
````

### Step 2: please use our supplied conda environment
### Step 2: Build an Env using our Conda file!

You simply need to have this .yaml file anywhere locally on your computer. So, let's download it!
You simply need to have this `.yaml` file anywhere locally on your computer. So, let's download it!

```{Hint}
Windows users: Be sure you have `git` installed along with anaconda: https://gitforwindows.org/
Expand All @@ -59,6 +59,7 @@ Windows users: Be sure to open the program terminal/cmd/anaconda prompt with a R
- **Now, in Terminal (or Anaconda Command Prompt for Windows users)**, if you clicked to download, go to your downloads folder. Or, if you cloned the repo, go to the DeepLabCut folder.

```{Hint}
:class: dropdown
If you cloned the repo onto your Desktop, the command may look like:
``cd C:\Users\YourUserName\Desktop\DeepLabCut\conda-environments``
You can (on Windows) hold SHIFT and right-click > Copy as path, or (on Mac) right-click and while in the menu press the OPTION key to reveal Copy as Pathname.
Expand All @@ -79,9 +80,9 @@ You can (on Windows) hold SHIFT and right-click > Copy as path, or (on Mac) righ
Now you should see (`nameofenv`) on the left of your terminal screen, i.e. ``(DEEPLABCUT_M1) YourName-MacBook...``
NOTE: no need to run pip install deeplabcut, as it is already installed!!! :)

**Great, that's it! DeepLabCut is installed!**
**Great, that's it! DeepLabCut is installed!** 🎉💜

Next, [head over to the Docs to decide which mode to use DeepLabCut in. You have both standard and multi-animal installed.](https://deeplabcut.github.io/DeepLabCut/docs/README.html)
🚨 Next, [head over to the Docs to decide which mode to use DeepLabCut in. You have both standard and multi-animal installed!](https://deeplabcut.github.io/DeepLabCut/docs/UseOverviewGuide.html#what-you-need-to-get-started)

## PIP:

Expand Down