Skip to content

Commit

Permalink
Updated install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
slottad committed Jul 14, 2023
1 parent 28f6715 commit 7dec88c
Showing 1 changed file with 10 additions and 13 deletions.
23 changes: 10 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,26 +24,23 @@ 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`
- `cd masskit`
- 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`

0 comments on commit 7dec88c

Please sign in to comment.