diff --git a/README.md b/README.md index 5ea06b4..a88aeea 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,9 @@ Masskit does this by taking advantage of modern software and hardware architectu ## Installation -On a Linux or macOS computer that has [Anaconda](https://www.anaconda.com/) and [Git](https://git-scm.com/) installed, run on the command line: +Masskit is currently only supported in a Python conda environment. If you do not have one installed we highly recommend installing [mambaforge](https://github.com/conda-forge/miniforge#mambaforge) + +On a Linux or macOS computer that has Conda and [Git](https://git-scm.com/) installed, run on the command line: - change to a directory that will hold the masskit directory - `git clone https://github.com/usnistgov/masskit.git` @@ -32,18 +34,13 @@ On a Linux or macOS computer that has [Anaconda](https://www.anaconda.com/) and - if you are going to use [Masskit_ai](https://github.com/usnistgov/masskit_ai.git), run `source environments/init_masskit.sh -m`, otherwise run `source environments/init_masskit.sh` - if you are going to use [Masskit_ai](https://github.com/usnistgov/masskit_ai.git) in cpu-only mode, run `source environments/init_masskit.sh -c` instead. -- run `pip install -e .` +- run `pip install .` -On a Windows computer that has [Anaconda](https://www.anaconda.com/) installed, -download -[init_masskit.bat](https://raw.githubusercontent.com/usnistgov/masskit/main/environments/init_masskit.bat) -and the masskit windows wheel file from the -[Releases](https://github.com/usnistgov/masskit/releases) page. Then run the -following from the Anconda prompt: +On a Windows computer that has Conda installed, download the masskit windows zip file from the +[Releases](https://github.com/usnistgov/masskit/releases) page and extract the contents. Then run the +following from the Conda prompt: -- change to the directory that contains the downloaded init_masskit.bat -- if you are going to use [Masskit_ai](https://github.com/usnistgov/masskit_ai.git), run `call init_masskit.bat /ml`, otherwise run -`call init_masskit.bat` - - if you are going to use [Masskit_ai](https://github.com/usnistgov/masskit_ai.git) in cpu-only mode, run `call init_masskit.bat /cpu` instead. -- run `pip install masskit-1.0.1-cp39-cp39-win_amd64.whl` +- change to the directory that contains the extracted files. +- run `call init_masskit.bat` +- run `pip install masskit-1.1.0-py3-none-any.whl`