Skip to content

Commit 23ea5d7

Browse files
authored
Merge pull request #189 from KumarLabJax/update-readme
small readme edits
2 parents b7da225 + 608ebe1 commit 23ea5d7

File tree

1 file changed

+3
-8
lines changed

1 file changed

+3
-8
lines changed

README.md

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ are generated from [this repository](https://github.com/KumarLabJax/deep-hrnet-m
3131
JABS was initially developed and tested on Python 3.10. See the `pyproject.toml` for a list of required Python
3232
packages. These packages are available from the Python Package Index (PyPI).
3333

34-
Currently, JABS supports Python 3.10, 3.11, 3.12, and 3.13.
34+
Currently, JABS supports Python 3.10 through 3.13.
3535

3636
## Python Env Setup
3737

@@ -76,11 +76,6 @@ If you've cloned the JABS repository, you can install by running the following c
7676

7777
`pip install .`
7878

79-
If you want to install the package in "editable" mode, use the `-e` flag. This links to the python files instead of
80-
copying them during installation so that they can be edited.
81-
82-
`pip install -e .`
83-
8479
#### Windows .bat scripts
8580

8681
There are two scripts that Windows users can use to simplify installing and running JABS. These can be executed by
@@ -100,7 +95,7 @@ After installing JABS, five commands will be added to the bin directory of your
10095
* jabs-stats: print accuracy statistics for the given classifier
10196
* jabs-convert-parquet: convert parquet pose file to JABS pose file format
10297

103-
You can run the <command> --help to get usage information for each of the commands.
98+
You can run the `<jabs command> --help` to get usage information for each of the commands.
10499

105100
**NOTE: On some platforms, the first time you run the JABS GUI it might take several minutes to launch. Subsequent
106101
startup times should be significantly reduced.**
@@ -168,6 +163,6 @@ the scope of this Readme.
168163
### Singularity/Linux
169164

170165
We supply a tested pair of singularity definition files. The [first vm](vm/behavior-classifier-vm.def) is intended for command-line use on
171-
compute clusters when scaling inferences. The [second vm](vm/behavior-classifier-gui-vm.def) is designed for interacting with the GUI in a portable
166+
compute clusters when scaling inferences. The [second vm](vm/behavior-classifier-vm-gui.def) is designed for interacting with the GUI in a portable
172167
environment. Please inspect the definition files for related linux packages to run the software.
173168

0 commit comments

Comments
 (0)