Skip to content
This repository was archived by the owner on Feb 9, 2024. It is now read-only.

Commit c01d37d

Browse files
authored
remove old installation instructions
1 parent a837219 commit c01d37d

1 file changed

Lines changed: 0 additions & 25 deletions

File tree

README.md

Lines changed: 0 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -4,31 +4,6 @@ Python package for image analysis of hair curvature and cross-section
44
## Install the package
55

66
> ### Prerequisites
7-
> To run any of the commands below, your machine **must** have a conda Python Installation. Conda is a Python packge and environment manager. You have the option to install anaconda or the smaller miniconda.
8-
> See [here](https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html) for more information and instructions on how to install conda for Windows, Mac OS, and Linux, respectively.
9-
> Once you have followed all the instructions and have a working Python Installation with Ana/miniconda , you can move forward.
10-
11-
1. Open a terminal.
12-
#### Mac OS:
13-
+ Open the *Terminal* application.
14-
#### Windows:
15-
+ Type `Anaconda` into your search bar and choose the `Anaconda Powershell` application.
16-
#### Linux:
17-
+ Open a terminal window using your search bar or the appropriate keyboard shortcut for your Linux distribution.
18-
19-
20-
2. Install the fibermorph conda environment
21-
+ Install the fibermorph package conda environment using one of two options:
22-
##### Option 1: Install the fibermorph conda environment system/user wide
23-
You can install the conda environment required to run fibermorph alongside other conda environments. This would allow you to call the fibermorph conda environment from outside the directory and to call it by name. If you have the necessary access and no conflicts (i.e. no other environments named `fibermorph`), it's recommended you install the environment as follows:
24-
+ Enter `conda env create -n fibermorph -f environment.yml` and wait for the environment to install in your directory
25-
+ Enter `conda activate fibermorph`
26-
In the future, you will be able to activate the environment each time using `conda activate fibermorph`
27-
##### Option 2: Install the fibermorph conda environment in the directory
28-
If you happen to have another conda environment named `fibermorph` or you want to isolate this conda environment to the directory `fibermorph/` for any other reason, you can install this conda environment using the following command instead:
29-
+ Enter `conda env create --prefix ./env -f environment.yml` and wait for the environment to install in your directory
30-
+ Enter `conda activate ./env`
31-
To call this environment in the future, you will have to use the environment path. If you are doing this from the `fibermorph/` directory, you should be able to call it with `conda activate ./env`. If you are calling the environment from elsewhere, it's recommended you copy the full pathname and replace `./env` with that.
327
338
## Test run
349
Before using this on any of your own data, it's recommended that you test that you test whether fibermorph is working properly on your machine.

0 commit comments

Comments
 (0)