Skip to content

Commit 7579bbb

Browse files
Update installation docs with PyPI instructions
1 parent 4fd356f commit 7579bbb

File tree

1 file changed

+48
-19
lines changed

1 file changed

+48
-19
lines changed

docs/user-guide/installation.md

Lines changed: 48 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,23 @@
22

33
There are several ways to install EMGIO depending on your needs.
44

5+
## From PyPI (Recommended)
6+
7+
The easiest way to install EMGIO is from PyPI:
8+
9+
```bash
10+
pip install emgio
11+
```
12+
513
## From GitHub Repository
614

7-
The recommended way to install the latest version of EMGIO is directly from the GitHub repository:
15+
To install the latest development version directly from GitHub:
16+
17+
```bash
18+
pip install git+https://github.com/neuromechanist/emgio.git
19+
```
20+
21+
Or clone and install:
822

923
```bash
1024
git clone https://github.com/neuromechanist/emgio.git
@@ -14,51 +28,66 @@ pip install .
1428

1529
## Development Installation
1630

17-
For development purposes, you can install EMGIO in editable mode:
31+
For development purposes, install EMGIO in editable mode with dev dependencies:
1832

1933
```bash
2034
git clone https://github.com/neuromechanist/emgio.git
2135
cd emgio
22-
pip install -e .
36+
pip install -e ".[dev]"
2337
```
2438

2539
This allows you to modify the source code and see the changes without reinstalling.
2640

41+
## Optional Dependencies
42+
43+
EMGIO provides optional dependency groups:
44+
45+
```bash
46+
# Development tools (pytest, ruff, coverage)
47+
pip install emgio[dev]
48+
49+
# Documentation tools (mkdocs, mkdocstrings)
50+
pip install emgio[docs]
51+
52+
# All optional dependencies
53+
pip install emgio[all]
54+
```
55+
2756
## Dependencies
2857

29-
EMGIO has the following dependencies:
58+
EMGIO has the following core dependencies:
3059

3160
| Dependency | Purpose | Minimum Version |
32-
|---------------|------------------------|----------------|
33-
| numpy | Array operations | - |
34-
| pandas | Data manipulation | - |
35-
| scipy | Signal processing | - |
36-
| matplotlib | Visualization | - |
37-
| pyedflib | EDF/BDF file handling | - |
61+
|---------------|------------------------|-----------------|
62+
| numpy | Array operations | >=1.20.0 |
63+
| pandas | Data manipulation | >=1.3.0 |
64+
| scipy | Signal processing | >=1.7.0 |
65+
| matplotlib | Visualization | >=3.4.0 |
66+
| pyedflib | EDF/BDF file handling | >=0.1.30 |
67+
| wfdb | WFDB format support | >=4.0.0 |
3868

39-
These dependencies will be automatically installed when you install EMGIO.
69+
These dependencies are automatically installed when you install EMGIO.
4070

41-
## Testing
71+
## Python Version
4272

43-
To run the tests, you need to install the test dependencies:
73+
EMGIO requires Python 3.11 or later. We test on Python 3.11, 3.12, 3.13, and 3.14.
4474

45-
```bash
46-
pip install -r test-requirements.txt
47-
```
75+
## Testing
4876

49-
Then you can run the tests with:
77+
To run the tests:
5078

5179
```bash
80+
pip install -e ".[dev]"
5281
pytest
5382
```
5483

5584
## Verifying Installation
5685

57-
You can verify that EMGIO is correctly installed by running:
86+
Verify that EMGIO is correctly installed:
5887

5988
```python
6089
import emgio
6190
print(emgio.__version__)
6291
```
6392

64-
If you don't see any error messages, EMGIO is installed correctly.
93+
You should see the version number (e.g., `0.2.0`) without any errors.

0 commit comments

Comments
 (0)