Skip to content

Commit c59a378

Browse files
authored
Add optional dependencies (#644)
* add optional dependencies * fix command in bash * rm extra pip
1 parent 5cdc4f4 commit c59a378

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

Diff for: docs/user_guide.md

+16
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
📚 **Contents:**
77

88
- :ref:`install`
9+
- :ref:`optional`
910
- :ref:`support`
1011
- :ref:`getting_started`
1112
- :ref:`catalog-section`
@@ -36,6 +37,21 @@
3637
pip install -v -e .
3738
```
3839

40+
.. _optional:
41+
42+
🔗 Optional dependencies
43+
--------------
44+
45+
Scivision supports optional dependencies, which are not installed by default. These dependencies are required for certain functionality, such as loading models from certain sources, or loading certain types of data.
46+
47+
- `cloud_extra`: install dependencies for loading data or models from cloud storage (e.g. AWS S3 and Google Cloud Storage)
48+
49+
To install the optional `cloud_extra` dependencies, run:
50+
51+
```bash
52+
pip install scivision[cloud_extra]
53+
```
54+
3955
.. _support:
4056

4157
📋 Support table

0 commit comments

Comments
 (0)